@grepr/cli 1.11.10-e534892 → 1.11.11-d027f41

package/build/dist/docs-index/70017de9-af25-4396-a1c1-64e6df6bf166.txt

@@ -1,34 +0,0 @@
-# Creates or updates a Datadog integration api key
-
-**PUT** `/v1/integrations/datadog/{id}/api-key`
-
-**Operation ID**: `upsertApiKey_1`
-**Summary**: Creates or updates a Datadog integration api key
-Creates an API key for a Datadog integration if it doesn't exist and updates it otherwise.  If the key is updated while the integration is being used by a pipeline, the  new key will be picked at pipeline restart, rescaling or an update.  Ingestion supports the previous and the updated key for up to 24 hours of  a key update. Make sure to change the key used by the agents to send data within  24 hours of an update for a seamless transition
-
-## Tags
-- Datadog Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `SecretApi`
-
-## Responses
-
-### 204
-
-Api key upserted successfully.
-
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/811992e6-5895-4a9c-9fe9-4928ea658d5c.txt

@@ -1,29 +0,0 @@
-# Get a S3 Data Warehouse integration
-
-**GET** `/v1/integrations/s3-data-warehouse/{id}`
-
-**Operation ID**: `get_7`
-**Summary**: Get a S3 Data Warehouse integration
-Gets an external S3 Data Warehouse integration
-
-## Tags
-- External S3 Data Warehouse Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 200
-
-S3 Data Warehouse integration retrieved successfully
-
-- **Content-Type**: `application/json` / `ReadS3DataWarehouse`
-### 401
-
-Unauthorized
-
-### 404
-
-S3 Data Warehouse integration not found

package/build/dist/docs-index/8235cfe9-a679-491d-88c5-9569c8b70f15.txt

@@ -1,194 +0,0 @@
-Learn how to use infrastructure as code (IaC) to manage your Grepr pipelines with the Grepr Terraform provider.
-
-# Manage Grepr pipelines with Terraform
-
-You can use the Grepr Terraform provider to manage Grepr pipelines using infrastructure as code (IaC) principles. With the Grepr Terraform provider, you can define, deploy, and manage your pipelines in a consistent and repeatable manner.
-
-## Requirements \[#tf-provider-reqs]
-
-To use the Grepr Terraform provider, you must have:
-
-* Terraform or OpenTofu CLI version 1.0 or later.
-* OAuth2 client credentials for authentication. To obtain the required credentials, create a service account in the Grepr UI. See [Manage Grepr service accounts](/admin/service-accounts).
-
-## Install the Grepr provider
-
-The Grepr provider is published to the [OpenTofu registry](https://search.opentofu.org/provider/grepr/grepr/). To install it, declare it in the `required_providers` block of your configuration. To use the OpenTofu CLI, use the following configuration:
-
-```hcl
-terraform {
-  required_providers {
-    grepr = {
-      source  = "grepr/grepr"
-      version = "~> 1.0"
-    }
-  }
-}
-```
-
-To use the Terraform CLI, you must use the fully qualified source address `registry.opentofu.org/grepr/grepr`:
-
-```hcl
-terraform {
-  required_providers {
-    grepr = {
-      source  = "registry.opentofu.org/grepr/grepr"
-      version = "~> 1.0"
-    }
-  }
-}
-```
-
-Then initialize your working directory to download the provider:
-
-```bash
-terraform init # Or tofu init
-```
-
-## Configure authentication for the Grepr Terraform provider
-
-To configure the required OAuth2 credentials for authentication, add a provider block to your Terraform configuration with the `host`, `client_id`, and `client_secret` fields:
-
-```hcl
-provider "grepr" {
-  host          = "https://<your-org>.app.grepr.ai"
-  client_id     = var.<grepr-client-id>
-  client_secret = var.<grepr-client-secret>
-}
-```
-
-Replace:
-
-* `<your-org>` with your organization name.
-* `<grepr-client-id>` with your service account client ID.
-* `<grepr-client-secret>` with your service account client secret.
-
-Alternatively, you can use environment variables to set the required credentials. The provider automatically reads these environment variables if you set them:
-
-```bash
-export GREPR_HOST=https://<your-org>.app.grepr.ai
-export GREPR_CLIENT_ID=<your-client-id>
-export GREPR_CLIENT_SECRET=<your-client-secret>
-```
-
-## Import an existing pipeline
-
-To bring an existing pipeline under Terraform management, use the `terraform import` command with the pipeline's ID or name:
-
-```bash
-terraform import grepr_pipeline.example <pipeline-id-or-name>
-```
-
-To automatically import an existing pipeline without using the `import` command, create a `grepr_pipeline` resource with the same name as the existing pipeline. The provider will detect and import the existing pipeline.
-
-### Tags \[#tf-pipeline-tags]
-
-Grepr sets the tags of a pipeline only when it creates the pipeline. The update API does not accept tags. For an existing pipeline, including a pipeline that you import, either leave `tags` unset or set it to the tags that the pipeline already has.
-
-## Example: create a pipeline
-
-The following example shows a simple pipeline that uses a Datadog log agent source, a Grok parser, and an Iceberg table sink. To improve maintainability and avoid conflicts with Terraform reserved symbols or keywords, Grepr recommends defining your pipeline's job graph in a separate JSON file. You then reference this JSON file in your Terraform configuration. This example demonstrates how to define a pipeline job graph in a JSON file and reference the file in the Terraform configuration.
-
-A common development workflow is to create a pipeline in the Grepr UI or API, test it and make changes until it meets your requirements, then copy the generated JSON to a file for use with your Terraform configuration. If you choose to create pipelines through the API, see [Create and manage jobs with the Grepr REST APIs](/apis/job-creation-guide).
-
-After you've completed development of your pipeline, to find its JSON definition in the UI, click **Jobs** in the menu bar, click the three-dot menu in the **Actions** column for your pipeline, and click **Edit JSON** to view and copy the JSON. Save the copied JSON to a file in your Terraform project, for example, `pipeline.json`:
-
-```json
-{
-  "vertices": [
-    {
-      "type": "datadog-log-agent-source",
-      "name": "source",
-      "integrationId": "<your-integration-id>"
-    },
-    {
-      "type": "grok-parser",
-      "name": "parser",
-      "grokParsingRules": [
-        "%{TIMESTAMP_ISO8601:timestamp} %{LOGLEVEL:level} %{GREEDYDATA:message}"
-      ]
-    },
-    {
-      "type": "logs-iceberg-table-sink",
-      "name": "sink",
-      "datasetId": "<your-dataset-id>"
-    }
-  ],
-  "edges": ["source -> parser", "parser -> sink"]
-}
-```
-
-`<your-integration-id>` and `<your-dataset-id>` are the identifiers of the Datadog integration and dataset used by this pipeline. If you copied the JSON from an existing pipeline, these fields are already set to the correct value.
-
-Then reference the JSON file in your Terraform configuration:
-
-```hcl
-resource "grepr_pipeline" "example" {
-  name           = "my_pipeline"
-  job_graph_json = file("${path.module}/pipeline.json")
-  desired_state  = "RUNNING"
-}
-```
-
-Use `terraform init` to download the provider, `terraform plan` to preview your changes, and `terraform apply` to apply the configuration and create the pipeline. With the OpenTofu CLI, use the equivalent `tofu` commands:
-
-```bash
-terraform init
-terraform plan
-terraform apply
-```
-
-You can also define the job graph directly in the Terraform configuration using `jsonencode`:
-
-```hcl
-resource "grepr_pipeline" "example" {
-  name = "my_pipeline"
-
-  job_graph_json = jsonencode({
-    vertices = [
-      {
-        type          = "datadog-log-agent-source"
-        name          = "source"
-        integrationId = var.datadog_integration_id
-      },
-      {
-        type = "grok-parser"
-        name = "parser"
-        grokParsingRules = ["%{TIMESTAMP_ISO8601:timestamp} %{LOGLEVEL:level} %{GREEDYDATA:message}"]
-      },
-      {
-        type      = "logs-iceberg-table-sink"
-        name      = "sink"
-        datasetId = var.dataset_id
-      }
-    ]
-    edges = ["source -> parser", "parser -> sink"]
-  })
-}
-```
-
-## Resource attributes
-
-The `grepr_pipeline` resource supports these attributes:
-
-| Attribute | Type | Required | Description |
-| --- | --- | --- | --- |
-| `name` | String | Yes | The pipeline name. Must be lowercase alphanumeric with underscores, 1-128 characters. |
-| `job_graph_json` | String | Yes | The job graph as a JSON string. Use `file()` to load from a JSON file or `jsonencode` to define inline. |
-| `desired_state` | String | No | The desired state: `RUNNING` or `STOPPED`. Defaults to `RUNNING`. |
-| `team_ids` | Set of Strings | No | Team IDs to associate with this pipeline. |
-| `tags` | Map of Strings | No | Custom tags. Grepr sets tags only when it creates the pipeline. See [Tags](#tf-pipeline-tags). |
-| `wait_for_state` | Boolean | No | Wait for the pipeline to reach the desired state. Defaults to `true`. |
-| `state_timeout` | Number | No | Timeout in seconds for state transitions. Defaults to `600`. |
-| `rollback_enabled` | Boolean | No | Roll the pipeline back to its last stable configuration when an update fails. Defaults to `true`. |
-
-### Read-only attributes
-
-| Attribute | Type | Description |
-| --- | --- | --- |
-| `id` | String | The unique identifier of the pipeline. |
-| `version` | Number | The current version of the pipeline. Increments on updates. |
-| `state` | String | The actual current state of the pipeline. |
-| `organization_id` | String | The organization ID that owns this pipeline. |
-| `created_at` | String | The timestamp when the pipeline was created. |
-| `updated_at` | String | The timestamp when the pipeline was last updated. |

package/build/dist/docs-index/94b4815c-bd82-48b3-a84d-d562f251c125.txt

@@ -1,34 +0,0 @@
-# Creates or updates the endpoint for the SumoLogic integration
-
-**PUT** `/v1/integrations/sumo/{id}/endpoint`
-
-**Operation ID**: `upsertEndpoint`
-**Summary**: Creates or updates the endpoint for the SumoLogic integration
-Sets the endpoint for a SumoLogic integration if it doesn't exist and updates it otherwise. If the key is updated while the integration is being used by a pipeline, the new key will be picked at pipeline restart, rescaling or an update. Ingestion supports the previous and the updated key for up to 24 hours of a key update. Make sure to change the key used by the agents to send data within 24 hours of an update for a seamless transition
-
-## Tags
-- Sumo Logic Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `SecretApi`
-
-## Responses
-
-### 204
-
-Api key upserted successfully.
-
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/a7bbfe3f-6ac7-4318-bb80-75ef45c4d4c6.txt

@@ -1,24 +0,0 @@
-# Delete a Splunk integration
-
-**DELETE** `/v1/integrations/splunk/{id}`
-
-**Operation ID**: `delete_16`
-**Summary**: Delete a Splunk integration
-Deletes an integration to connect to Splunk. This will delete the associated keys as well. No-op if already deleted.
-
-## Tags
-- Splunk Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 204
-
-Integration deleted successfully
-
-### 401
-
-Unauthorized

package/build/dist/docs-index/ab49a851-79b5-4235-baf2-4c790503259c.txt

@@ -1,24 +0,0 @@
-# Delete a NewRelic integration
-
-**DELETE** `/v1/integrations/newrelic/{id}`
-
-**Operation ID**: `delete_12`
-**Summary**: Delete a NewRelic integration
-Deletes an integration to connect to NewRelic. This will delete the associated keys as well. No-op if already deleted.
-
-## Tags
-- New Relic Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 204
-
-Integration deleted successfully
-
-### 401
-
-Unauthorized

package/build/dist/docs-index/ad5f58cf-4ace-4815-8803-fc4ee7084682.txt

@@ -1,29 +0,0 @@
-# Get a NewRelic integration
-
-**GET** `/v1/integrations/newrelic/{id}`
-
-**Operation ID**: `get_14`
-**Summary**: Get a NewRelic integration
-Get an integration to connect to NewRelic.
-
-## Tags
-- New Relic Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 200
-
-Integration retrieved successfully
-
-- **Content-Type**: `application/json` / `ReadNewRelic`
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/ae630074-77a3-4dea-b921-bc7af32b4d64.txt

@@ -1,24 +0,0 @@
-# Delete a Data Warehouse integration
-
-**DELETE** `/v1/integrations/data-warehouse/{id}`
-
-**Operation ID**: `delete_4`
-**Summary**: Delete a Data Warehouse integration
-Deletes a Data Warehouse integration if it exists. No-op otherwise.
-
-## Tags
-- Grepr-hosted Data Warehouse Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 200
-
-Data Warehouse integration deleted successfully
-
-### 401
-
-Unauthorized

package/build/dist/docs-index/b0572620-9e42-480b-9222-65a5e477c6a4.txt

@@ -1,20 +0,0 @@
-# List all SumoLogic integrations
-
-**GET** `/v1/integrations/sumo`
-
-**Operation ID**: `list_19`
-**Summary**: List all SumoLogic integrations
-Get all SumoLogic integrations.
-
-## Tags
-- Sumo Logic Integration
-## Responses
-
-### 200
-
-Integrations retrieved successfully
-
-- **Content-Type**: `application/json` / `ItemsCollectionReadSumo`
-### 401
-
-Unauthorized

package/build/dist/docs-index/b3e4b3ba-3c33-4827-bdab-2ec35af7d360.txt

@@ -1,39 +0,0 @@
-# Set a Datadog integration's API keys
-
-**PUT** `/v1/integrations/datadog/{id}/api-keys`
-
-**Operation ID**: `setApiKeys`
-**Summary**: Set a Datadog integration's API keys
-Replaces the integration's entire set of API keys in one atomic write. Existing keys are referenced by id (kept or rotated), new keys carry only a value, and omitted keys are removed; one key is marked as the send key used to write data back to Datadog. If any key is rejected the existing set is left unchanged. All keys are accepted for inbound telemetry. Requires the organization to have multiple Datadog API keys enabled. Adding, removing, relabeling, or rotating a key other than the send key is allowed while the integration's pipeline is running; a change that affects the send key (which key it is, or its value) requires the pipeline to be stopped, since that key is baked into the running Flink job.
-
-## Tags
-- Datadog Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `SetApiKeysRequest`
-
-## Responses
-
-### 200
-
-API keys updated successfully
-
-- **Content-Type**: `application/json` / `ReadDatadog`
-### 401
-
-Unauthorized
-
-### 404
-
-Integration or a referenced key not found.
-
-### 409
-
-The key count exceeds the limit, or the change affects the send key while the integration is in use by a running pipeline.

package/build/dist/docs-index/b515eea7-e02c-4980-998c-55a2a010de61.txt

@@ -1,28 +0,0 @@
-# Delete a Datadog integration app key
-
-**DELETE** `/v1/integrations/datadog/{id}/app-key`
-
-**Operation ID**: `deleteAppKey`
-**Summary**: Delete a Datadog integration app key
-Deletes a Datadog integration app key. No-op if already deleted.
-
-## Tags
-- Datadog Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 204
-
-App key deleted successfully.
-
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/be99bed6-ec0b-4e55-8857-7c2211811711.txt

@@ -1,20 +0,0 @@
-# List all NewRelic integrations
-
-**GET** `/v1/integrations/newrelic`
-
-**Operation ID**: `list_14`
-**Summary**: List all NewRelic integrations
-Get all NewRelic integrations.
-
-## Tags
-- New Relic Integration
-## Responses
-
-### 200
-
-Integrations retrieved successfully
-
-- **Content-Type**: `application/json` / `ItemsCollectionReadNewRelic`
-### 401
-
-Unauthorized

package/build/dist/docs-index/c49613e4-932c-4f4f-976e-cd806cffa898.txt

@@ -1,40 +0,0 @@
-# Get Splunk integration exceptions
-
-**GET** `/v1/integrations/splunk/{id}/exceptions`
-
-**Operation ID**: `getIntegrationExceptions_2`
-**Summary**: Get Splunk integration exceptions
-Returns a paginated list of vendor imported exceptions for the specified Splunk integration
-
-## Tags
-- Splunk Integration
-## Parameters
-
-- **id** (required) - path
-  - Integration ID
-  - Type: string
-- **pageSize** (optional) - query
-  - Page size (100-2000, default: 100)
-  - Type: integer
-- **page** (optional) - query
-  - Page number (0-based, default: 0)
-  - Type: integer
-
-## Responses
-
-### 200
-
-Successfully retrieved integration exceptions
-
-- **Content-Type**: `application/json` / `IntegrationExceptionsList`
-### 401
-
-Unauthorized
-
-### 403
-
-Access denied
-
-### 404
-
-Integration not found

package/build/dist/docs-index/c6c36399-d93e-4862-b26a-02512a049e6b.txt

@@ -1,32 +0,0 @@
-# Create a Splunk integration
-
-**POST** `/v1/integrations/splunk`
-
-**Operation ID**: `create_17`
-**Summary**: Create a Splunk integration
-Creates an integration to connect to Splunk.
-
-## Tags
-- Splunk Integration
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `WriteSplunk`
-
-## Responses
-
-### 200
-
-Integration created successfully
-
-- **Content-Type**: `application/json` / `ReadSplunk`
-### 401
-
-Unauthorized
-
-### 409
-
-Integration already exists.
-
-- **Content-Type**: `application/json` / `ReadSplunk`

package/build/dist/docs-index/c977e543-e98c-43be-bff7-5d1c3d5060f0.txt

@@ -1,18 +0,0 @@
-# List all S3 Data Warehouse integrations
-
-**GET** `/v1/integrations/s3-data-warehouse`
-
-**Operation ID**: `list_7`
-**Summary**: List all S3 Data Warehouse integrations
-## Tags
-- External S3 Data Warehouse Integration
-## Responses
-
-### 200
-
-S3 Data Warehouse integrations retrieved successfully
-
-- **Content-Type**: `application/json` / `ItemsCollectionReadS3DataWarehouse`
-### 401
-
-Unauthorized

package/build/dist/docs-index/d050ee49-7c7e-471e-8243-5b25607811a9.txt

@@ -1,38 +0,0 @@
-# Creates or updates a Datadog integration app key
-
-**PUT** `/v1/integrations/datadog/{id}/app-key`
-
-**Operation ID**: `upsertAppKey`
-**Summary**: Creates or updates a Datadog integration app key
-Creates an app key for a Datadog integration if it doesn't exist and updates it otherwise.  If the key is updated while the integration is being used by a pipeline, the  new key will be picked at pipeline restart, rescaling or an update. 
-
-## Tags
-- Datadog Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `SecretApi`
-
-## Responses
-
-### 204
-
-App key upserted successfully.
-
-### 400
-
-App key is missing a required authorization scope.
-
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/d0a10324-a80a-4bae-a0c5-08bdde9f2ccb.txt

@@ -1,24 +0,0 @@
-# Delete a Datadog integration
-
-**DELETE** `/v1/integrations/datadog/{id}`
-
-**Operation ID**: `delete_3`
-**Summary**: Delete a Datadog integration
-Deletes an integration to connect to Datadog. This will delete the associated keys as well. No-op if already deleted.
-
-## Tags
-- Datadog Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 204
-
-Integration deleted successfully
-
-### 401
-
-Unauthorized