---
canonical_url: "https://docs.composio.dev/toolkits/imply_polaris"
markdown_url: "https://docs.composio.dev/toolkits/imply_polaris.md"
product: "platform"
version: null
last_updated: null
---

# Imply Polaris

Imply Polaris is a fully managed real-time analytics platform for ingesting, querying, and visualizing event data.

- **Category:** analytics
- **Auth:** API_KEY, S2S_OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 108
- **Triggers:** 0
- **Slug:** `IMPLY_POLARIS`
- **Version:** 00000000_00

## Tools

### Cancel Async Sql Query

**Slug:** `IMPLY_POLARIS_CANCEL_ASYNC_SQL_QUERY`

Cancel an async query in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query_id` | string | Yes | The server-generated ID of the query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Job

**Slug:** `IMPLY_POLARIS_CANCEL_JOB`

Irreversibly cancel a Polaris ingestion job. A canceled job cannot be resumed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Server-generated job ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Alert

**Slug:** `IMPLY_POLARIS_CREATE_ALERT`

Create an alert in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert` | object | Yes | Alert configuration using the provider's native nested field names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Connection

**Slug:** `IMPLY_POLARIS_CREATE_CONNECTION`

Create an Azure, Confluent, Schema Registry, Kafka, Kinesis, push-streaming, or S3 connection in the project configured on the connected Imply Polaris account. Kafka PEM private keys must be unencrypted because credential values cannot be accepted through the tool request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ssl` | object | No | Optional Kafka SSL authentication and encryption settings. |
| `name` | string | Yes | Unique connection name using letters, numbers, periods, underscores, or hyphens. |
| `type` | string ("azure" | "confluent" | "confluent_schema_registry" | "kafka" | "kinesis" | "push_streaming" | "s3") | Yes | Type in the connection request. |
| `urls` | array | No | Schema Registry URLs for confluent_schema_registry. |
| `bucket` | string | No | S3 bucket name. Required for s3. |
| `prefix` | string | No | Optional Azure blob or S3 object-key prefix. |
| `stream` | string | No | Kinesis stream name. Required for kinesis. |
| `secrets` | string | No | Connection credentials. Required for azure, confluent, Schema Registry, and kafka; optional for s3. |
| `container` | string | No | Azure container name. Required for azure. |
| `topicName` | string | No | Kafka topic name or pattern. Required for kafka and confluent. |
| `clientRack` | string | No | Optional physical rack identifier for a Kafka client. |
| `awsEndpoint` | string | No | AWS service endpoint. Required for kinesis and s3. |
| `description` | string | No | Description in the connection request. |
| `storageAccount` | string | No | Azure Blob Storage account name. Required for azure. |
| `bootstrapServers` | string | No | Kafka broker host and port pairs. Required for kafka and confluent. |
| `awsAssumedRoleArn` | string | No | AWS IAM role ARN. Required for kinesis and optional for s3. |
| `topicNameIsPattern` | boolean | No | Whether topicName is a regular expression. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dashboard

**Slug:** `IMPLY_POLARIS_CREATE_DASHBOARD`

Create a dashboard in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dashboard` | object | Yes | Documented dashboard request body. Preserve provider-native nested keys and validate against the operation schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dashboard Page

**Slug:** `IMPLY_POLARIS_CREATE_DASHBOARD_PAGE`

Create a dashboard page in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `label` | string | No | Label in the dashboard request. |
| `tiles` | array | No | Initial tile definitions. Each item requires type (blank, visualization, or markdown) and may include id, title, position, content, or the provider-native visualization essence. |
| `page_id` | string | No | Optional ID for the new dashboard page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dashboard Page Tile

**Slug:** `IMPLY_POLARIS_CREATE_DASHBOARD_PAGE_TILE`

Create a blank, Markdown, or data-cube visualization tile on a dashboard page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `tile` | string | Yes | Blank, Markdown, or visualization tile definition. |
| `page_id` | string | Yes | Page ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Data Cube

**Slug:** `IMPLY_POLARIS_CREATE_DATA_CUBE`

Create a data cube in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_cube` | object | Yes | Documented data cube request body. Preserve provider-native nested keys and validate against the operation schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Data Cube Dimension

**Slug:** `IMPLY_POLARIS_CREATE_DATA_CUBE_DIMENSION`

Create a data cube dimension in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `geo` | boolean | No | Geo in the data cube request. |
| `url` | string | No | Url in the data cube request. |
| `type` | string ("TIME" | "STRING" | "SET/STRING" | "NUMBER" | "BOOLEAN" | "IP" | "TIME_SERIES") | No | Type in the data cube request. |
| `group` | string | No | Group in the data cube request. |
| `order` | integer | No | Array order of the new dimension |
| `title` | string | No | Title in the data cube request. |
| `format` | string | No | Format in the data cube request. |
| `formula` | string | No | Formula in the data cube request. |
| `ip_prefix` | boolean | No | Ip Prefix in the data cube request. |
| `description` | string | No | Description in the data cube request. |
| `dimension_id` | string | No | Optional ID for the new dimension. |
| `geo_encoding` | string ("ISO 3166-1 Alpha-2" | "ISO 3166-1 Alpha-3" | "ISO 3166-2" | "UN M49" | "Geohash" | "lng-coordinate" | "lat-coordinate") | No | Geo Encoding in the data cube request. |
| `granularities` | array | No | Time granularity definitions available for this dimension, using provider-native granularity names and durations. |
| `bucketing_strategy` | string ("defaultBucket" | "defaultNoBucket" | "neverBucket" | "alwaysBucket") | No | Bucketing Strategy in the data cube request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Data Cube Measure

**Slug:** `IMPLY_POLARIS_CREATE_DATA_CUBE_MEASURE`

Create a data cube measure in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `group` | string | No | Group in the data cube request. |
| `order` | integer | No | Array order of the new measure |
| `title` | string | No | Title in the data cube request. |
| `units` | string | No | Units in the data cube request. |
| `formula` | string | No | Formula in the data cube request. |
| `transform` | string ("none" | "percent-of-parent" | "percent-of-root") | No | Transform in the data cube request. |
| `measure_id` | string | No | Optional ID for the new measure. |
| `description` | string | No | Description in the data cube request. |
| `number_style` | object | No | Number formatting with provider-native notation, precision, and affix keys. |
| `scale_behavior` | string ("pin-zero" | "unpinned") | No | Scale Behavior in the data cube request. |
| `comparison_colors` | object | No | Comparison color mapping for positive, negative, and neutral values. |
| `missing_value_fill` | string ("zero" | "none" | "previous" | "interpolate") | No | Missing Value Fill in the data cube request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Embedding Link

**Slug:** `IMPLY_POLARIS_CREATE_EMBEDDING_LINK`

Create an embedding link in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embedding_link` | object | Yes | Embedding link body. Example: {name: Quake dashboard API, description: One-day quake dashboard, layout: visualization-only, restricted: true, ttl: 3600000, nonFilterableDimensions: [Latitude, Longitude], nonShowableDimensions: [Url], viewDescription: {dashboard: dashboard-id}}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Embedding Link Secret Key

**Slug:** `IMPLY_POLARIS_CREATE_EMBEDDING_LINK_SECRET_KEY`

Create a secret key for an embedding link in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Embedding link ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Job

**Slug:** `IMPLY_POLARIS_CREATE_JOB`

Create a job in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("batch" | "delete_data" | "drop_table" | "restore_data" | "streaming" | "sql") | Yes | Job type. |
| `query` | string | No | SQL ingestion statement. Required when type is sql. |
| `source` | object | No | Job input source. Its keys depend on the job type, such as an uploaded file list, connection, table, or SQL source. |
| `target` | object | No | Job output target, typically containing type=table and tableName; replacement targets may also include intervals. |
| `context` | object | No | Optional SQL ingestion context parameters. |
| `interval` | string | No | Single ISO 8601 interval to restore. Required when type is restore_data. |
| `mappings` | array | No | Input-to-table mappings. Each item requires columnName and expression and may set isAggregation. |
| `delete_all` | boolean | No | Delete all rows without specifying target intervals. |
| `parameters` | array | No | Positional parameters referenced by the SQL query. |
| `replace_all` | boolean | No | Replace all target data. Use only with replacement ingestion and no target intervals. |
| `soft_delete` | boolean | No | Retain deleted data for the provider's restoration grace period. |
| `ingestion_mode` | string ("append" | "replace") | No | Append new data or replace matching target intervals. |
| `partitioned_by` | string ("second" | "minute" | "five_minute" | "ten_minute" | "fifteen_minute" | "thirty_minute" | "hour" | "six_hour" | "eight_hour" | "day" | "month" | "quarter" | "year" | "all") | No | Time partitioning granularity for the ingestion job. |
| `filter_expression` | string | No | SQL expression used to filter source rows. |
| `clustering_columns` | array | No | Columns used to cluster data within each partition. |
| `max_parse_exceptions` | integer | No | Maximum tolerated parse exceptions. |
| `create_table_if_not_exists` | boolean | No | Create the target table when it does not exist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Lookup

**Slug:** `IMPLY_POLARIS_CREATE_LOOKUP`

Create a lookup in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name in the lookup request. |
| `source` | object | Yes | Existing Polaris table used by the lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project

**Slug:** `IMPLY_POLARIS_CREATE_PROJECT`

Create a project through the connected Imply Polaris regional API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `spec` | object | Yes | Project plan, lifecycle state, protections, and region. |
| `metadata` | object | Yes | Project identity metadata containing the required project name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Report

**Slug:** `IMPLY_POLARIS_CREATE_REPORT`

Create a report in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report` | object | Yes | Complete Reports v1 body. Required: creationDate and owner. Example: {creationDate: 2019-08-24T14:15:22Z, owner: user-id, title: Daily report, delivery: {frequency: P1D, day: 1}, timeFrame: {interval: previous_day, startDay: 0, startTime: 0}, exploreEssence: {parameters: {}, transferGroups: {}, dataCube: cube-id, moduleName: overall, where: TRUE}}. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Table

**Slug:** `IMPLY_POLARIS_CREATE_TABLE`

Create a table in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique table name. |
| `type` | string ("detail" | "aggregate") | Yes | Detail tables store individual rows; aggregate tables roll up measures. |
| `description` | string | No | Description in the table request. |
| `schema_mode` | string ("flexible" | "strict") | No | Schema Mode in the table request. |
| `table_schema` | array | No | Table columns. Each item defines a column name and data type, plus provider-supported column properties. |
| `storage_policy` | object | No | Storage policy using provider-native retention and tiering keys for table data. |
| `time_resolution` | string ("millisecond" | "second" | "minute" | "fifteen_minute" | "thirty_minute" | "hour" | "day" | "week" | "month" | "quarter" | "year" | "all") | No | Resolution used to store and query the primary time column. |
| `query_granularity` | object | No | Rollup query granularity object, such as {type: simple}; period granularities may also set duration, timeZone, and origin. |
| `clustering_columns` | array | No | Columns used for sorting within each partition, in priority order. Aggregate tables may use dimensions only. |
| `partitioning_granularity` | string ("second" | "minute" | "five_minute" | "ten_minute" | "fifteen_minute" | "thirty_minute" | "hour" | "six_hour" | "eight_hour" | "day" | "week" | "month" | "quarter" | "year" | "all") | No | Partitioning Granularity in the table request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Alert

**Slug:** `IMPLY_POLARIS_DELETE_ALERT`

Delete an alert in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Alert ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Connection

**Slug:** `IMPLY_POLARIS_DELETE_CONNECTION`

Delete a connection in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name the connection to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Dashboard

**Slug:** `IMPLY_POLARIS_DELETE_DASHBOARD`

Delete a dashboard in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Dashboard Page

**Slug:** `IMPLY_POLARIS_DELETE_DASHBOARD_PAGE`

Delete a page in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `page_id` | string | Yes | Page ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Dashboard Page Tile

**Slug:** `IMPLY_POLARIS_DELETE_DASHBOARD_PAGE_TILE`

Delete a tile in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `page_id` | string | Yes | Page ID. |
| `tile_id` | string | Yes | Tile ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Data Cube

**Slug:** `IMPLY_POLARIS_DELETE_DATA_CUBE`

Delete a data cube in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Data Cube Dimension

**Slug:** `IMPLY_POLARIS_DELETE_DATA_CUBE_DIMENSION`

Delete a dimension in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `dimension_id` | string | Yes | Dimension identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Data Cube Measure

**Slug:** `IMPLY_POLARIS_DELETE_DATA_CUBE_MEASURE`

Delete a measure in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `measure_id` | string | Yes | Measure identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Embedding Link

**Slug:** `IMPLY_POLARIS_DELETE_EMBEDDING_LINK`

Delete an embedding link in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Embedding link ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Embedding Link Secret Key

**Slug:** `IMPLY_POLARIS_DELETE_EMBEDDING_LINK_SECRET_KEY`

Delete a secret key for an embedding link in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Embedding link ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete File

**Slug:** `IMPLY_POLARIS_DELETE_FILE`

Delete a file in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the file (may contain slashes) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Lookup

**Slug:** `IMPLY_POLARIS_DELETE_LOOKUP`

Delete a lookup in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lookup_name` | string | Yes | The name of a lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `IMPLY_POLARIS_DELETE_PROJECT`

Delete a project through the connected Imply Polaris regional API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Report

**Slug:** `IMPLY_POLARIS_DELETE_REPORT`

Delete a report in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Report ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Alert

**Slug:** `IMPLY_POLARIS_GET_ALERT`

Get alert details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Alert ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Alert Evaluation

**Slug:** `IMPLY_POLARIS_GET_ALERT_EVALUATION`

Get alert evaluation details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Alert ID. |
| `evaluation_id` | string | Yes | Evaluation ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Async Sql Results

**Slug:** `IMPLY_POLARIS_GET_ASYNC_SQL_RESULTS`

Get one result page for an async query, or omit cursor to return all pages sequentially.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Zero-based page ID listed by GET_ASYNC_SQL_STATUS. Omit to return all pages sequentially. |
| `filename` | string | No | Optional download filename, at most 255 characters. It cannot contain `/`, `\`, `:`, `*`, `?`, `"`, `<`, `>`, `&#124;`, null, or newline characters. |
| `query_id` | string | Yes | The server-generated ID of the query. |
| `result_format` | string ("object" | "array" | "objectLines" | "arrayLines" | "csv") | No | Defines the format in which the results are presented. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Async Sql Status

**Slug:** `IMPLY_POLARIS_GET_ASYNC_SQL_STATUS`

Get status of an async query in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `detail` | boolean | No | Fetch additional details about the query, which includes the information about different stages, counters for each stage, and any warnings. |
| `query_id` | string | Yes | The server-generated ID of the query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Connection

**Slug:** `IMPLY_POLARIS_GET_CONNECTION`

Get connection details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the connection to get. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Connection Metadata

**Slug:** `IMPLY_POLARIS_GET_CONNECTION_METADATA`

Get project-level connection metadata: the external ID and Imply AWS IAM role ARN used when granting Polaris access to AWS resources. Unlike GET_CONNECTION, this parameterless action does not return one named connection's configuration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dashboard

**Slug:** `IMPLY_POLARIS_GET_DASHBOARD`

Get dashboard details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dashboard Page

**Slug:** `IMPLY_POLARIS_GET_DASHBOARD_PAGE`

Get page details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `page_id` | string | Yes | Page ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dashboard Page Tile

**Slug:** `IMPLY_POLARIS_GET_DASHBOARD_PAGE_TILE`

Get tile details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `page_id` | string | Yes | Page ID. |
| `tile_id` | string | Yes | Tile ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Cube

**Slug:** `IMPLY_POLARIS_GET_DATA_CUBE`

Get data cube details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Cube Dimension

**Slug:** `IMPLY_POLARIS_GET_DATA_CUBE_DIMENSION`

Get dimension details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `dimension_id` | string | Yes | Dimension identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Cube Measure

**Slug:** `IMPLY_POLARIS_GET_DATA_CUBE_MEASURE`

Get measure details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `measure_id` | string | Yes | Measure identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Embedding Link

**Slug:** `IMPLY_POLARIS_GET_EMBEDDING_LINK`

Get embedding link details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Embedding link ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get File Metadata

**Slug:** `IMPLY_POLARIS_GET_FILE_METADATA`

Get file details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the file (may contain slashes) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job

**Slug:** `IMPLY_POLARIS_GET_JOB`

Get job details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The server-generated ID of the job for which to get the metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Logs

**Slug:** `IMPLY_POLARIS_GET_JOB_LOGS`

Get job logs in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The server-generated ID of the job for which to get the metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Metrics

**Slug:** `IMPLY_POLARIS_GET_JOB_METRICS`

Get job metrics in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The server-generated ID of the job for which to get the metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Progress

**Slug:** `IMPLY_POLARIS_GET_JOB_PROGRESS`

Get job overall progress in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The server-generated ID of the job for which to get the metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Status

**Slug:** `IMPLY_POLARIS_GET_JOB_STATUS`

Get job execution status in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Server-generated job ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lookup

**Slug:** `IMPLY_POLARIS_GET_LOOKUP`

Get lookup details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lookup_name` | string | Yes | The name of a lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Network Policy

**Slug:** `IMPLY_POLARIS_GET_NETWORK_POLICY`

Get whether the project's regional API IP allowlist is enabled and return entries keyed by IPv4 address or CIDR.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `IMPLY_POLARIS_GET_PROJECT`

Get project details through the connected Imply Polaris regional API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report

**Slug:** `IMPLY_POLARIS_GET_REPORT`

Get report details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Report ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Evaluation

**Slug:** `IMPLY_POLARIS_GET_REPORT_EVALUATION`

Get report evaluation details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Report ID. |
| `evaluation_id` | string | Yes | Evaluation ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Table

**Slug:** `IMPLY_POLARIS_GET_TABLE`

Get table details in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `table_name` | string | Yes | Name of the table for which to get information. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Alert Evaluations

**Slug:** `IMPLY_POLARIS_LIST_ALERT_EVALUATIONS`

Get alert evaluations in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Alert ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Alerts

**Slug:** `IMPLY_POLARIS_LIST_ALERTS`

List all alerts in the project configured on the connected Imply Polaris account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Connections

**Slug:** `IMPLY_POLARIS_LIST_CONNECTIONS`

List all connections in the project configured on the connected Imply Polaris account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dashboard Data Cubes

**Slug:** `IMPLY_POLARIS_LIST_DASHBOARD_DATA_CUBES`

Get dashboard data cubes in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dashboard Pages

**Slug:** `IMPLY_POLARIS_LIST_DASHBOARD_PAGES`

Get dashboard pages in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dashboard Page Tiles

**Slug:** `IMPLY_POLARIS_LIST_DASHBOARD_PAGE_TILES`

Get dashboard page tiles in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `page_id` | string | Yes | Page ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dashboards

**Slug:** `IMPLY_POLARIS_LIST_DASHBOARDS`

List all dashboards in the project configured on the connected Imply Polaris account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Data Cube Dimensions

**Slug:** `IMPLY_POLARIS_LIST_DATA_CUBE_DIMENSIONS`

Get data cube dimensions in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Data Cube Measures

**Slug:** `IMPLY_POLARIS_LIST_DATA_CUBE_MEASURES`

Get data cube measures in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Data Cubes

**Slug:** `IMPLY_POLARIS_LIST_DATA_CUBES`

List all data cubes in the project configured on the connected Imply Polaris account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Embedding Links

**Slug:** `IMPLY_POLARIS_LIST_EMBEDDING_LINKS`

Get embedding links in the project configured on the connected Imply Polaris account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Files

**Slug:** `IMPLY_POLARIS_LIST_FILES`

List one offset-based page of files. When has_more is true, pass next_cursor to the next call to continue listing files.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | A result limit for pagination. |
| `cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `sort_order` | string ("ASC" | "DESC") | No | The order to sort file results by. |
| `sort_column` | string ("compression_format" | "data_format" | "digest_algo" | "digest_hash" | "name" | "size_bytes" | "uploaded_by_user_name" | "uploaded_on_dt") | No | The column to sort file results by. |
| `search_string` | string | No | Filter the results to only include files that have the provided string contained within one of their fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Jobs

**Slug:** `IMPLY_POLARIS_LIST_JOBS`

List one page of jobs in the project configured on the connected Imply Polaris account, with a cursor when more results are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | array | No | Return jobs whose type matches any supplied value. |
| `limit` | integer | No | A result limit for pagination. |
| `cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `sort_order` | string ("ASC" | "DESC") | No | The order to sort job results by. |
| `sort_column` | string ("created_by_user_name" | "created_date_time" | "execution_status" | "last_updated_date_time" | "source_name" | "source_type" | "source_connection_name" | "source_table_name" | "target_table_name" | "type") | No | Sort results by one of the following fields: * `created_by_user_name` : User that created the job. * `created_date_time` : Date the job was created. * `execution_status` : Job's execution status. * `last_updated_date_time` : Date the job was last updated. * `source_name` : Job's source name, such as a connection name. * `source_type` : Job's source type, such as `connection` or `table`. * `source_connection_name` : Deprecated, use `source_name` instead. * `source_table_name` : Deprecated, use `source_name` instead. * `target_table_name` : Table that the job targets. * `type` : Job type. |
| `health_status` | array | No | Return jobs whose health status matches any supplied value. |
| `search_string` | string | No | Filter results to those jobs where the given string is contained in one of the job's fields. |
| `connection_name` | array | No | The connection to filter jobs by. |
| `target_table_id` | string | No | Filters results for jobs associated with a particular target table id. |
| `execution_status` | array | No | Return jobs whose execution status matches any supplied value. |
| `target_table_name` | string | No | Filters results for jobs associated with a particular target table name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lookup Aliases

**Slug:** `IMPLY_POLARIS_LIST_LOOKUP_ALIASES`

List all aliases for a lookup in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lookup_name` | string | Yes | The name of a lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lookups

**Slug:** `IMPLY_POLARIS_LIST_LOOKUPS`

List all lookups in the project configured on the connected Imply Polaris account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Report Evaluations

**Slug:** `IMPLY_POLARIS_LIST_REPORT_EVALUATIONS`

Get report evaluations in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Report ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Reports

**Slug:** `IMPLY_POLARIS_LIST_REPORTS`

List all reports in the project configured on the connected Imply Polaris account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tables

**Slug:** `IMPLY_POLARIS_LIST_TABLES`

List all tables in a project in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_count` | integer | No | Filters results by the number of segments specified. |
| `partitioning_granularity` | string ("second" | "minute" | "five_minute" | "ten_minute" | "fifteen_minute" | "thirty_minute" | "hour" | "six_hour" | "eight_hour" | "day" | "week" | "month" | "quarter" | "year" | "all") | No | Return tables with this partitioning granularity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Unused Table Segments

**Slug:** `IMPLY_POLARIS_LIST_UNUSED_TABLE_SEGMENTS`

List one page of unused table segments, with a cursor when another page may be available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | The maximum number of segments to return in the response. |
| `cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `interval` | string | No | Filters results for unused segments by the time interval specified. |
| `sort_order` | string ("ASC" | "DESC") | No | The order with which the resulting segments should be sorted with respect to their `segmentId`. If not specified, the order of the results is not guaranteed. |
| `table_name` | string | Yes | Name of the table for which to get information. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Push Connection Events

**Slug:** `IMPLY_POLARIS_PUSH_CONNECTION_EVENTS`

Push events to a Polaris connection in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `json_data` | string | No | JSON event payload; provide exactly one of json_data, text_data, or binary_file. |
| `text_data` | string | No | Plain-text event payload; provide exactly one payload field. |
| `binary_file` | object | No | A file the caller hands IN. ``s3key`` is an S3/R2 reference (production) or a base64 ``data:`` URL (self-hosted ``FILE_BACKEND=base64``) — the ``FileStore`` knows which. Mirrors ``mercury/tools/files.py`` field-for-field. |
| `connection_name` | string | Yes | The name of the connection to push data to. Note that for legacy tables created via the v1 API, the connection name is named after the table ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Alert

**Slug:** `IMPLY_POLARIS_REPLACE_ALERT`

Replace the complete alert in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Alert ID. |
| `alert` | object | Yes | Complete replacement alert. Use the provider-native nested field names documented by Imply Polaris. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Dashboard

**Slug:** `IMPLY_POLARIS_REPLACE_DASHBOARD`

Replace the complete dashboard in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `dashboard` | object | Yes | Documented dashboard request body. Preserve provider-native nested keys and validate against the operation schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Dashboard Page

**Slug:** `IMPLY_POLARIS_REPLACE_DASHBOARD_PAGE`

Replace the complete page in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `label` | string | No | Label in the dashboard request. |
| `tiles` | array | No | Complete replacement tile list. Each item requires type and may include id, title, position, content, or provider-native visualization essence fields. |
| `page_id` | string | Yes | Page ID. |
| `replacement_page_id` | string | No | Optional replacement ID stored in the page body; separate from the page path ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Dashboard Page Tile

**Slug:** `IMPLY_POLARIS_REPLACE_DASHBOARD_PAGE_TILE`

Replace the complete tile in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `page_id` | string | Yes | Page ID. |
| `tile_id` | string | Yes | Tile ID. |
| `dashboard` | object | Yes | Documented dashboard request body. Preserve provider-native nested keys and validate against the operation schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Data Cube

**Slug:** `IMPLY_POLARIS_REPLACE_DATA_CUBE`

Replace the complete data cube in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `data_cube` | object | Yes | Documented data cube request body. Preserve provider-native nested keys and validate against the operation schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Data Cube Dimension

**Slug:** `IMPLY_POLARIS_REPLACE_DATA_CUBE_DIMENSION`

Replace the complete dimension in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `geo` | boolean | No | Geo in the data cube request. |
| `url` | string | No | Url in the data cube request. |
| `type` | string ("TIME" | "STRING" | "SET/STRING" | "NUMBER" | "BOOLEAN" | "IP" | "TIME_SERIES") | No | Type in the data cube request. |
| `group` | string | No | Group in the data cube request. |
| `title` | string | No | Title in the data cube request. |
| `format` | string | No | Format in the data cube request. |
| `formula` | string | No | Formula in the data cube request. |
| `ip_prefix` | boolean | No | Ip Prefix in the data cube request. |
| `description` | string | No | Description in the data cube request. |
| `dimension_id` | string | Yes | Dimension identifier |
| `geo_encoding` | string ("ISO 3166-1 Alpha-2" | "ISO 3166-1 Alpha-3" | "ISO 3166-2" | "UN M49" | "Geohash" | "lng-coordinate" | "lat-coordinate") | No | Geo Encoding in the data cube request. |
| `granularities` | array | No | Time granularity definitions available for this dimension, using provider-native granularity names and durations. |
| `bucketing_strategy` | string ("defaultBucket" | "defaultNoBucket" | "neverBucket" | "alwaysBucket") | No | Bucketing Strategy in the data cube request. |
| `replacement_dimension_id` | string | No | Optional replacement ID stored in the dimension body; separate from the dimension path ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Data Cube Measure

**Slug:** `IMPLY_POLARIS_REPLACE_DATA_CUBE_MEASURE`

Replace the complete measure in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `group` | string | No | Group in the data cube request. |
| `title` | string | No | Title in the data cube request. |
| `units` | string | No | Units in the data cube request. |
| `formula` | string | No | Formula in the data cube request. |
| `transform` | string ("none" | "percent-of-parent" | "percent-of-root") | No | Transform in the data cube request. |
| `measure_id` | string | Yes | Measure identifier. |
| `description` | string | No | Description in the data cube request. |
| `number_style` | object | No | Number formatting with provider-native notation, precision, and affix keys. |
| `scale_behavior` | string ("pin-zero" | "unpinned") | No | Scale Behavior in the data cube request. |
| `comparison_colors` | object | No | Comparison color mapping for positive, negative, and neutral values. |
| `missing_value_fill` | string ("zero" | "none" | "previous" | "interpolate") | No | Missing Value Fill in the data cube request. |
| `replacement_measure_id` | string | No | Optional replacement ID stored in the measure body; separate from the measure path ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Embedding Link

**Slug:** `IMPLY_POLARIS_REPLACE_EMBEDDING_LINK`

Replace the complete embedding link in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Embedding link ID. |
| `embedding_link` | object | Yes | Documented embedding link request body. Preserve provider-native nested keys and validate against the operation schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Report

**Slug:** `IMPLY_POLARIS_REPLACE_REPORT`

Replace the complete report in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Report ID. |
| `report` | object | Yes | Documented report request body. Preserve provider-native nested keys and validate against the operation schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Table

**Slug:** `IMPLY_POLARIS_REPLACE_TABLE`

Replace the complete table in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Immutable table name. |
| `type` | string ("detail" | "aggregate") | Yes | Immutable table type. |
| `version` | integer | Yes | Current table version used for optimistic concurrency. |
| `table_name` | string | Yes | Name of the table for which to get information. |
| `description` | string | No | Description in the table request. |
| `schema_mode` | string ("flexible" | "strict") | No | Schema Mode in the table request. |
| `table_schema` | array | No | Updated table columns. Existing columns can be changed or removed only when the table is empty and has no active ingestion jobs. |
| `storage_policy` | object | No | Storage Policy in the table request. |
| `time_resolution` | string ("millisecond" | "second" | "minute" | "fifteen_minute" | "thirty_minute" | "hour" | "day" | "week" | "month" | "quarter" | "year" | "all") | No | Resolution used to store and query the primary time column. |
| `query_granularity` | object | No | Rollup query granularity object, such as {type: simple}; period granularities may also set duration, timeZone, and origin. |
| `clustering_columns` | array | No | Columns used for sorting within each partition. |
| `partitioning_granularity` | string ("second" | "minute" | "five_minute" | "ten_minute" | "fifteen_minute" | "thirty_minute" | "hour" | "six_hour" | "eight_hour" | "day" | "week" | "month" | "quarter" | "year" | "all") | No | Partitioning Granularity in the table request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset Job

**Slug:** `IMPLY_POLARIS_RESET_JOB`

Reset job to apply streaming ingestion offset in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The server-generated ID of the job |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Job

**Slug:** `IMPLY_POLARIS_RUN_JOB`

Start or resume a Polaris ingestion job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Server-generated job ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Sql Query

**Slug:** `IMPLY_POLARIS_RUN_SQL_QUERY`

Query precached data in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Query in the SQL query request. |
| `header` | boolean | No | Header in the SQL query request. |
| `context` | object | No | Context in the SQL query request. |
| `parameters` | array | No | Parameters in the SQL query request. |
| `types_header` | boolean | No | Types Header in the SQL query request. |
| `result_format` | string ("object" | "array" | "objectLines" | "arrayLines" | "csv") | No | Result Format in the SQL query request. |
| `sql_types_header` | boolean | No | Sql Types Header in the SQL query request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Async SQL Ingestion

**Slug:** `IMPLY_POLARIS_START_ASYNC_SQL_INGESTION`

Irreversibly insert or replace table data by starting an asynchronous SQL ingestion job. This mutates project data; use START_ASYNC_SQL_QUERY for read-only SELECT statements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | INSERT or REPLACE SQL statement that asynchronously mutates table data. |
| `context` | object | No | Optional provider-native SQL execution context. |
| `parameters` | array | No | Positional parameter values referenced by placeholders in the statement. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Async Sql Query

**Slug:** `IMPLY_POLARIS_START_ASYNC_SQL_QUERY`

Start a read-only SELECT query asynchronously. Use START_ASYNC_SQL_INGESTION for INSERT or REPLACE statements that mutate table data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Read-only SELECT statement to run asynchronously. |
| `context` | object | No | Context in the SQL query request. |
| `parameters` | array | No | Positional parameter values referenced by placeholders in the SELECT statement. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Suspend Job

**Slug:** `IMPLY_POLARIS_SUSPEND_JOB`

Pause a running Polaris ingestion job so it can be resumed later.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Server-generated job ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Connection

**Slug:** `IMPLY_POLARIS_TEST_CONNECTION`

Test a connection in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the connection to test. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Alert

**Slug:** `IMPLY_POLARIS_UPDATE_ALERT`

Update specified alert properties in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Alert ID. |
| `type` | string ("overall" | "within-split") | No | Whether the alert evaluates overall data or each split. |
| `owner` | string | No | Alert owner. |
| `title` | string | No | Alert title. |
| `admins` | object | No | Audience allowed to administer the alert. |
| `filter` | object | No | Filters applied before evaluating alert conditions. |
| `splits` | string | No | Split configuration used to group alert evaluations. |
| `compare` | object | No | Comparison configuration for the alert. |
| `disabled` | boolean | No | Whether alert evaluation is disabled. |
| `instance` | string | No | Alert instance identifier. |
| `severity` | string ("info" | "warning" | "error" | "ok") | No | Alert severity. |
| `webhooks` | array | No | Webhook destinations notified by the alert. |
| `data_cube` | string | No | Data cube queried by the alert. |
| `conditions` | array | No | Conditions that trigger the alert. |
| `recipients` | object | No | Audience that receives alert notifications. |
| `time_frame` | string | No | ISO 8601 duration of data evaluated by the alert. |
| `read_access` | object | No | Audience allowed to read the alert. |
| `example_query` | string | No | Example query associated with the alert. |
| `check_frequency` | string | No | ISO 8601 duration between alert evaluations. |
| `external_emails` | array | No | External email addresses notified by the alert. |
| `date_time_to_start` | string | No | Date and time when alert evaluation starts. |
| `condition_operation` | string ("and" | "or") | No | Logical operation joining multiple conditions. |
| `replacement_alert_id` | string | No | Replacement alert ID, when the provider permits changing it. |
| `send_email_to_recipients` | boolean | No | Whether to email the configured recipients. |
| `latest_data_strategy_override` | string ("query" | "query-floored-P1D" | "predefined" | "inherit") | No | Strategy used to select the latest available data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Connection

**Slug:** `IMPLY_POLARIS_UPDATE_CONNECTION`

Update a connection in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ssl` | object | No | Kafka SSL authentication and encryption settings. |
| `name` | string | Yes | The name of the connection to update. |
| `type` | string ("azure" | "confluent" | "confluent_schema_registry" | "kafka" | "kinesis" | "push_streaming" | "s3") | Yes | Type in the connection request. |
| `urls` | array | No | Confluent Schema Registry URLs. |
| `bucket` | string | No | S3 bucket name. |
| `prefix` | string | No | Prefix restricting the connection to specific objects. |
| `stream` | string | No | Kinesis stream name. |
| `secrets` | string | No | Replacement connection credentials. Omit credential fields that should remain unchanged. |
| `container` | string | No | Azure Blob Storage container name. |
| `topic_name` | string | No | Kafka topic name or topic-name pattern. |
| `client_rack` | string | No | Physical rack identifier for this Kafka client. |
| `description` | string | No | Description in the connection request. |
| `aws_endpoint` | string | No | AWS Kinesis or S3 service endpoint. |
| `storage_account` | string | No | Azure Blob Storage account name. |
| `bootstrap_servers` | string | No | Kafka or Confluent broker host and port pairs. |
| `aws_assumed_role_arn` | string | No | AWS IAM role ARN to assume. |
| `topic_name_is_pattern` | boolean | No | Whether topic_name is a regular expression. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dashboard

**Slug:** `IMPLY_POLARIS_UPDATE_DASHBOARD`

Update specified dashboard properties in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `type` | string ("classic" | "dashboard2") | No | Type in the dashboard request. |
| `pages` | array | No | Dashboard pages; each item may contain id, label, and a tiles list. |
| `title` | string | No | Title in the dashboard request. |
| `palette` | object | No | Dashboard color palette using provider-native color and scale keys. |
| `pages_tile` | string ("show" | "hide") | No | Pages Tile in the dashboard request. |
| `description` | string | No | Description in the dashboard request. |
| `filter_tile` | string ("show" | "hide") | No | Filter Tile in the dashboard request. |
| `read_access` | object | No | Read-access rule containing provider-native user, group, or role assignments. |
| `modify_access` | object | No | Modify-access rule containing provider-native user, group, or role assignments. |
| `default_compare` | object | No | Default comparison configuration for dashboards with global comparison enabled. |
| `default_filters` | array | No | Default filter definitions applied when the dashboard opens. |
| `default_measures` | array | No | Default measure identifiers for dashboards with global measures enabled. |
| `has_global_compare` | boolean | No | Has Global Compare in the dashboard request. |
| `enforce_time_filter` | boolean | No | Enforce Time Filter in the dashboard request. |
| `has_global_measures` | boolean | No | Has Global Measures in the dashboard request. |
| `pages_color_summary` | string ("show" | "hide") | No | Pages Color Summary in the dashboard request. |
| `default_refresh_rate` | string | No | Default Refresh Rate in the dashboard request. |
| `min_auto_refresh_rate` | string | No | Min Auto Refresh Rate in the dashboard request. |
| `replacement_dashboard_id` | string | No | Optional replacement ID stored in the dashboard body; separate from the dashboard path ID. |
| `filter_query_default_duration` | string | No | Filter Query Default Duration in the dashboard request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dashboard Page

**Slug:** `IMPLY_POLARIS_UPDATE_DASHBOARD_PAGE`

Update specified page properties in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `label` | string | No | Label in the dashboard request. |
| `tiles` | array | No | Replacement tile list. Each item requires type and may include id, title, position, content, or provider-native visualization essence fields. |
| `page_id` | string | Yes | Page ID. |
| `replacement_page_id` | string | No | Optional replacement ID stored in the page body; separate from the page path ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dashboard Page Tile

**Slug:** `IMPLY_POLARIS_UPDATE_DASHBOARD_PAGE_TILE`

Update specified tile properties in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Dashboard ID. |
| `type` | string ("blank" | "visualization" | "markdown") | No | Type in the dashboard request. |
| `title` | string | No | Title in the dashboard request. |
| `content` | string | No | Content in the dashboard request. |
| `essence` | object | No | Visualization configuration used by visualization tiles. |
| `page_id` | string | Yes | Page ID. |
| `tile_id` | string | Yes | Tile ID. |
| `position` | object | No | Tile grid placement using provider-native row, column, width, and height values. |
| `can_expand` | boolean | No | Can Expand in the dashboard request. |
| `description` | string | No | Description in the dashboard request. |
| `info_hidden` | boolean | No | Info Hidden in the dashboard request. |
| `legend_side` | string ("none" | "right" | "bottom") | No | Legend Side in the dashboard request. |
| `title_hidden` | boolean | No | Title Hidden in the dashboard request. |
| `facet_essence` | object | No | Facet visualization configuration used when the tile renders a facet view. |
| `explore_essence` | object | No | Explore visualization configuration used when the tile renders an explore view. |
| `replacement_tile_id` | string | No | Optional replacement ID stored in the tile body; separate from the tile path ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Data Cube

**Slug:** `IMPLY_POLARIS_UPDATE_DATA_CUBE`

Update specified data cube properties in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `title` | string | No | Title in the data cube request. |
| `rollup` | boolean | No | Rollup in the data cube request. |
| `source` | object | No | Queryable source definition, including the provider-native table or SQL source keys. |
| `options` | object | No | Provider-native data cube feature options. |
| `palette` | object | No | Visualization color palette using provider-native color and scale keys. |
| `measures` | array | No | Measure definitions, each using provider-native id, title, formula, units, and formatting keys. |
| `instances` | object | No | Named data cube instances keyed by instance ID. |
| `attributes` | array | No | Attribute definitions, each using provider-native id, title, formula, and formatting keys. |
| `dimensions` | array | No | Dimension definitions, each using provider-native id, title, formula, type, and formatting keys. |
| `query_mode` | string ("sql" | "plywood") | No | Query Mode in the data cube request. |
| `description` | string | No | Description in the data cube request. |
| `read_access` | object | No | Read-access rule containing provider-native user, group, or role assignments. |
| `filter_token` | string | No | Filter Token in the data cube request. |
| `user_filters` | object | No | User-specific filter definitions keyed by user ID. |
| `group_filters` | object | No | Group-level filter definitions keyed by group ID. |
| `modify_access` | object | No | Modify-access rule containing provider-native assignments. |
| `query_caching` | string ("allow" | "disable") | No | Query Caching in the data cube request. |
| `default_filter` | object | No | Provider-native filter expression applied by default. |
| `subset_formula` | string | No | Subset Formula in the data cube request. |
| `download_access` | object | No | Download-access rule containing provider-native assignments. |
| `default_duration` | string | No | Default Duration in the data cube request. |
| `default_timezone` | string | No | Default Timezone in the data cube request. |
| `default_parameters` | string | No | Default Parameters in the data cube request. |
| `enforce_time_filter` | boolean | No | Enforce Time Filter in the data cube request. |
| `formulae_visibility` | string ("show" | "hide") | No | Formulae Visibility in the data cube request. |
| `min_alert_frequency` | string | No | Min Alert Frequency in the data cube request. |
| `allow_filter_combine` | boolean | No | Allow Filter Combine in the data cube request. |
| `default_facet_splits` | array | No | Default facet split definitions identifying dimensions and split values. |
| `default_refresh_rate` | string | No | Default Refresh Rate in the data cube request. |
| `latest_data_strategy` | string ("query" | "query-floored-P1D" | "predefined") | No | Latest Data Strategy in the data cube request. |
| `min_alert_time_frame` | string | No | Min Alert Time Frame in the data cube request. |
| `custom_facet_compares` | array | No | Named custom facet comparison definitions. |
| `default_facet_compare` | object | No | Default facet comparison definition. |
| `default_having_filter` | object | No | Provider-native aggregate filter applied after grouping. |
| `default_visualization` | string | No | Default Visualization in the data cube request. |
| `min_auto_refresh_rate` | string | No | Min Auto Refresh Rate in the data cube request. |
| `require_group_filters` | boolean | No | Require Group Filters in the data cube request. |
| `restricted_edit_access` | object | No | Restricted-edit access rule containing provider-native assignments. |
| `special_time_dimension` | string | No | Special Time Dimension in the data cube request. |
| `replacement_data_cube_id` | string | No | Optional replacement ID stored in the data cube body; separate from the data cube path ID. |
| `default_pinned_dimensions` | array | No | Dimension IDs pinned by default. |
| `default_selected_measures` | array | No | Measure IDs selected by default. |
| `latest_time_filter_granularity` | string | No | Latest Time Filter Granularity in the data cube request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Data Cube Dimension

**Slug:** `IMPLY_POLARIS_UPDATE_DATA_CUBE_DIMENSION`

Update specified dimension properties in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `geo` | boolean | No | Geo in the data cube request. |
| `url` | string | No | Url in the data cube request. |
| `type` | string ("TIME" | "STRING" | "SET/STRING" | "NUMBER" | "BOOLEAN" | "IP" | "TIME_SERIES") | No | Type in the data cube request. |
| `group` | string | No | Group in the data cube request. |
| `title` | string | No | Title in the data cube request. |
| `format` | string | No | Format in the data cube request. |
| `formula` | string | No | Formula in the data cube request. |
| `ip_prefix` | boolean | No | Ip Prefix in the data cube request. |
| `description` | string | No | Description in the data cube request. |
| `dimension_id` | string | Yes | Dimension identifier |
| `geo_encoding` | string ("ISO 3166-1 Alpha-2" | "ISO 3166-1 Alpha-3" | "ISO 3166-2" | "UN M49" | "Geohash" | "lng-coordinate" | "lat-coordinate") | No | Geo Encoding in the data cube request. |
| `granularities` | array | No | Time granularity definitions available for this dimension, using provider-native granularity names and durations. |
| `bucketing_strategy` | string ("defaultBucket" | "defaultNoBucket" | "neverBucket" | "alwaysBucket") | No | Bucketing Strategy in the data cube request. |
| `replacement_dimension_id` | string | No | Optional replacement ID stored in the dimension body; separate from the dimension path ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Data Cube Measure

**Slug:** `IMPLY_POLARIS_UPDATE_DATA_CUBE_MEASURE`

Update specified measure properties in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Data cube identifier |
| `group` | string | No | Group in the data cube request. |
| `title` | string | No | Title in the data cube request. |
| `units` | string | No | Units in the data cube request. |
| `formula` | string | No | Formula in the data cube request. |
| `transform` | string ("none" | "percent-of-parent" | "percent-of-root") | No | Transform in the data cube request. |
| `measure_id` | string | Yes | Measure identifier. |
| `description` | string | No | Description in the data cube request. |
| `number_style` | object | No | Number formatting with provider-native notation, precision, and affix keys. |
| `scale_behavior` | string ("pin-zero" | "unpinned") | No | Scale Behavior in the data cube request. |
| `comparison_colors` | object | No | Comparison color mapping for positive, negative, and neutral values. |
| `missing_value_fill` | string ("zero" | "none" | "previous" | "interpolate") | No | Missing Value Fill in the data cube request. |
| `replacement_measure_id` | string | No | Optional replacement ID stored in the measure body; separate from the measure path ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Embedding Link

**Slug:** `IMPLY_POLARIS_UPDATE_EMBEDDING_LINK`

Update specified embedding link properties in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Embedding link ID. |
| `embedding_link` | object | Yes | Documented embedding link request body. Preserve provider-native nested keys and validate against the operation schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Lookup

**Slug:** `IMPLY_POLARIS_UPDATE_LOOKUP`

Update a lookup in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source` | object | Yes | Replacement table source for the lookup. |
| `lookup_name` | string | Yes | The name of a lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Network Policy

**Slug:** `IMPLY_POLARIS_UPDATE_NETWORK_POLICY`

Enable or disable the project's regional API IP allowlist and set entries keyed by IPv4 address or CIDR.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Whether to enforce the network policy. When false, Polaris retains the policy but accepts requests from any IP address. |
| `entries` | object | No | Network policy entries keyed by IPv4 address or CIDR. Each value describes the allow policy for that address or range; set a value to null to remove that entry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `IMPLY_POLARIS_UPDATE_PROJECT`

Update a project through the connected Imply Polaris regional API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the project. |
| `spec` | object | Yes | Project plan, lifecycle state, protections, and region. |
| `metadata` | object | Yes | Complete project identity metadata containing the project name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Report

**Slug:** `IMPLY_POLARIS_UPDATE_REPORT`

Update specified report properties in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Report ID. |
| `owner` | string | No | Owner in the report request. |
| `title` | string | No | Title in the report request. |
| `admins` | object | No | Administrative access assignments using provider-native user and group keys. |
| `essence` | object | No | Pivot visualization configuration used when preferred_view is pivot1 or pivot2. |
| `delivery` | object | No | Delivery schedule and channel configuration using provider-native frequency and destination keys. |
| `disabled` | boolean | No | Disabled in the report request. |
| `timezone` | string | No | Timezone in the report request. |
| `recipients` | object | No | Internal report recipient assignments using provider-native user and group keys. |
| `send_email` | boolean | No | Send Email in the report request. |
| `time_frame` | object | No | Report time range using provider-native start, end, or relative-duration keys. |
| `description` | string | No | Description in the report request. |
| `file_format` | string ("csv" | "tsv" | "xlsx" | "json") | No | File Format in the report request. |
| `read_access` | object | No | Read-access assignments using provider-native user and group keys. |
| `creation_date` | string | No | Creation Date in the report request. |
| `facet_essence` | object | No | Facet visualization configuration used by the report. |
| `download_limit` | string | No | Maximum number of rows to include in the report attachment. |
| `preferred_view` | string ("pivot1" | "pivot2" | "explore") | No | Preferred View in the report request. |
| `send_data_file` | boolean | No | Send Data File in the report request. |
| `explore_essence` | object | No | Explore visualization configuration used when preferred_view is explore. |
| `external_emails` | array | No | External email addresses that receive the report. |
| `add_total_row_to_file` | boolean | No | Add Total Row To File in the report request. |
| `replacement_report_id` | string | No | Optional replacement ID stored in the report body; separate from the report path ID. |
| `enforce_decimal_formatting` | boolean | No | Enforce Decimal Formatting in the report request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File

**Slug:** `IMPLY_POLARIS_UPLOAD_FILE`

Upload a file in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Local or uploaded file containing data to add to the Polaris project. |
| `data_format` | string ("avro_ocf" | "avro_stream" | "csv" | "kafka" | "kinesis" | "nd-json" | "orc" | "parquet" | "protobuf" | "regex") | No | If specified, the format of the data. Otherwise, Polaris infers the data format from the filename or the `Content-Type` HTTP header in the multipart form request. For more information on supported data formats, see [Supported data and file formats](https://docs.imply.io/ui/saas/help/supported-formats.html). |
| `compression_format` | string ("none" | "bz2" | "gz" | "sz" | "xz" | "zstd") | No | If specified, the compression used for the file. Otherwise, Polaris infers the compression from the filename or the `Content-Type` HTTP header in the multipart form request. Supported compression formats: * `bz2` - bzip2 * `gz` - gzip * `sz` - [Snappy framing format](https://github.com/google/snappy/blob/master/framing_format.txt) * `xz` - XZ Utils (previously LZMA Utils) * `zstd` - [ZStandard](https://facebook.github.io/zstd/) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Lookup Aliases

**Slug:** `IMPLY_POLARIS_UPSERT_LOOKUP_ALIASES`

Create or update aliases for a lookup in the project configured on the connected Imply Polaris account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `values` | array | Yes | Complete alias set to retain. Each item requires key, name, and value; omitted existing aliases are removed. |
| `lookup_name` | string | Yes | The name of a lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |