@grepr/cli 1.11.9-8252ade → 1.11.10-7dcac0a

package/build/dist/docs-index/295d0892-0562-484f-8b40-7ece7a59f347.txt

@@ -1,29 +0,0 @@
-# Get a Splunk integration with exceptions
-
-**GET** `/v1/integrations/splunk/{id}/with-exceptions`
-
-**Operation ID**: `getWithExceptions_2`
-**Summary**: Get a Splunk integration with exceptions
-Get an integration to connect to Splunk with vendor imported exceptions populated.
-
-## Tags
-- Splunk Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 200
-
-Integration retrieved successfully with exceptions
-
-- **Content-Type**: `application/json` / `ReadSplunk`
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/2f0db52a-85dd-46cb-a2c6-1ecf6d01cb5a.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/392b8e40-49e5-4fe6-a531-4e81fc4f8281.txt

@@ -1,35 +0,0 @@
-# Update a Data Warehouse integration
-
-**PUT** `/v1/integrations/data-warehouse/{id}`
-
-**Operation ID**: `update_4`
-**Summary**: Update a Data Warehouse integration
-Updates an existing Data Warehouse integration.
-
-## Tags
-- Grepr-hosted Data Warehouse Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `WriteDataWarehouse`
-
-## Responses
-
-### 200
-
-Data Warehouse integration updated successfully
-
-- **Content-Type**: `application/json` / `ReadDataWarehouse`
-### 401
-
-Unauthorized
-
-### 404
-
-Data Warehouse integration not found

package/build/dist/docs-index/40f1688c-0f08-4a54-a6c2-b09c69296d36.txt

@@ -1,40 +0,0 @@
-# Create or update a single OTLP integration secret header
-
-**PUT** `/v1/integrations/otlp/{id}/secret-headers/{name}`
-
-**Operation ID**: `upsertSecretHeader`
-**Summary**: Create or update a single OTLP integration secret header
-Creates or updates a single secret HTTP header for an OTLP integration.
-
-## Tags
-- OpenTelemetry Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-- **name** (required) - path
-  - Type: string
-
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `SecretApi`
-
-## Responses
-
-### 204
-
-Secret header updated successfully
-
-### 400
-
-Invalid header name or reserved header name
-
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/418b2239-bf35-41ad-98e5-2f32485d8545.txt

@@ -1,29 +0,0 @@
-# Retrieve OTLP integration token in clear text
-
-**GET** `/v1/integrations/otlp/{id}/token`
-
-**Operation ID**: `getToken`
-**Summary**: Retrieve OTLP integration token in clear text
-Retrieves the plain-text authentication token for an OTLP integration.
-
-## Tags
-- OpenTelemetry Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Responses
-
-### 200
-
-Token retrieved successfully
-
-- **Content-Type**: `application/json` / `ClearSecret`
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.

package/build/dist/docs-index/43b1ef41-c4b2-4a7d-a09e-4e2387863a1c.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/4976b2b8-58f3-4b43-a3f8-574fbc377fb9.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/4ae840b7-bafb-45d9-af6d-ff5b7013f021.txt

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

package/build/dist/docs-index/4c15313e-1b0e-42ce-b026-de4fd3f5eb9b.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/54944f41-eaef-4544-a98b-1bcfb5604baf.txt

@@ -1,39 +0,0 @@
-# Update a Splunk integration.
-
-**PUT** `/v1/integrations/splunk/{id}`
-
-**Operation ID**: `update_16`
-**Summary**: Update a Splunk integration.
-Updates an integration to connect to Splunk. The version should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.
-
-## Tags
-- Splunk Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `WriteSplunk`
-
-## Responses
-
-### 200
-
-Integration updated successfully
-
-- **Content-Type**: `application/json` / `ReadSplunk`
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.
-
-### 409
-
-Integration was modified or deleted concurrently.

package/build/dist/docs-index/54b02cd5-ca56-401f-b345-9d3aa8d6d0ed.txt

@@ -1,40 +0,0 @@
-# Get New Relic integration exceptions
-
-**GET** `/v1/integrations/newrelic/{id}/exceptions`
-
-**Operation ID**: `getIntegrationExceptions_1`
-**Summary**: Get New Relic integration exceptions
-Returns a paginated list of vendor imported exceptions for the specified New Relic integration
-
-## Tags
-- New Relic 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/5bfc69a1-97d1-4e74-9a64-4374db902075.txt

@@ -1,104 +0,0 @@
-Learn about administrative functions in the Grepr platform, including user interfaces providing full management of users, teams, and roles.
-
-# Grepr administration
-
-The Grepr platform includes administrative functions to:
-
-* Manage users, teams, and roles. You can add users, organize users into teams, assign roles, and control access to resources across the organization. These functions are accessible through the user-friendly Grepr UI and the REST API.
-* Create and manage service accounts for programmatic access to the Grepr API. Service accounts are identities that can be used to authenticate to Grepr resources without relying on user credentials.
-* Monitor, audit, and troubleshoot your Grepr environment with system logs. You can use system logs to track user activity, resource usage, and system performance.
-
-The platform also supports infrastructure as code (IaC) workflows for pipeline deployment and management using Terraform, and securely forwarding observability data to Grepr over private AWS networking with AWS PrivateLink.
-
-## Manage users
-
-You can use the **Users** pane in the Grepr user management UI to manage users in your organization. You can view users, view and edit their roles, remove users, and invite new users.
-
-In the **Users** pane, you can also manage the roles assigned to each user.
-
-See [Manage users in the Grepr platform](/admin/manage-users).
-
-## Manage teams
-
-The **Teams** pane in the Grepr user management UI lets you create and manage teams in your organization and assign users as team members or team leaders. You can also use teams to manage access to jobs, integrations, templates, and datasets.
-
-See [Manage teams in the Grepr platform](/admin/manage-teams).
-
-## Manage SSO claim mappings
-
-The **SSO Claim Mappings** pane in the Grepr user management UI lets you create and manage SSO claim mappings for your organization. With SSO claim mappings, you can automatically assign organization roles and team memberships to users when they sign in through your identity provider (IdP).
-
-See [Manage SSO claim mappings in the Grepr platform](/admin/manage-claim-mappings).
-
-## Manage service accounts
-
-The **Service Accounts** pane in the Grepr developer settings UI lets you create service accounts for programmatic access to the Grepr API, assign roles to them, and manage their credentials.
-
-See [Manage Grepr service accounts](/admin/service-accounts).
-
-## Manage Grepr pipelines with Terraform
-
-The Grepr Terraform provider enables infrastructure as code management of Grepr pipelines. With the Terraform provider, you can:
-
-* Define pipelines as code in your version control system.
-* Automate pipeline deployment as part of your CI/CD workflows.
-* Manage multiple environments, such as development, staging, and production, with consistent configurations.
-* Track changes to pipeline configurations over time.
-
-See [Manage Grepr pipelines with Terraform](/admin/terraform-provider).
-
-## Monitor system activity in your Grepr environment
-
-The **System Logs** page in the Grepr UI lets you monitor and audit activity in your Grepr environment. You can view the activity information captured for Grepr resources, including jobs, integrations, datasets, and your organization. You can also audit user activity in your Grepr environment.
-
-See [View and search system activity in Grepr](/admin/activity-logs).
-
-## Connect to Grepr with AWS PrivateLink
-
-You can use Grepr's AWS PrivateLink endpoint service to send observability data to Grepr over private AWS networking instead of the public internet. With the PrivateLink endpoint service, your data stays on the AWS private network and never traverses the public internet, reduces the networking resources required to send data to Grepr from your AWS environment, and can reduce data transfer costs compared to routing ingest traffic over the public internet. See [Securely forward observability data to Grepr with AWS PrivateLink](/admin/private-link).
-
-## Frequently Asked Questions
-
-### What is the difference between organization-level roles and team roles in Grepr?
-
-Organization-level roles like Admin, Member, and Reader control global access to Grepr features. Team roles (Leader/Member) are scoped to specific teams and allow for more granular access control. A user can be a team Leader without being an organization-level Admin.
-
-### How do I invite users to my Grepr organization?
-
-In the Users pane of the user management UI, click 'Invite new users' and enter email addresses. You can optionally assign roles and team assignments to invited users before sending the invitation. Users receive an email invitation they must respond to join the organization.
-
-### Can I manage users and teams through the REST API?
-
-Yes, Grepr provides REST APIs for complete user and team management. You can use the Users API and Roles API endpoints documented in the OpenAPI specification to programmatically manage users, roles, and team memberships.
-
-### What permissions do I need to access the user management UI?
-
-You must have the view:users permission to access the user management UI. This permission is automatically granted to organization Admins and team Leaders.
-
-### How do custom roles work in Grepr?
-
-Custom roles allow you to define specific permissions for different resources (jobs, integrations, datasets, etc.). You can select which resources a custom role has access to and what permissions it grants (view, edit, create, delete, or all).
-
-### Can a user be assigned to multiple teams?
-
-Yes, a user can be assigned to multiple teams with different roles in each team. For example, a user can be a Leader in one team and a Member in another team simultaneously.
-
-### What happens when I remove a user from my organization?
-
-When you remove a user, they are deleted from your organization and all their access is revoked immediately. They lose access to all organization-level resources and all team-scoped resources.
-
-### How do I ensure proper access control when assigning users to teams?
-
-Follow the principle of least privilege by granting users only the access they need. Use team membership to scope access to specific resources, and use custom roles for fine-grained permission control when the built-in Admin, Member, and Reader roles don't meet your requirements.
-
-### What is the difference between editing a user and editing a custom role?
-
-Editing a user allows you to update their name, email, and assign or change their organization-level roles and team memberships. Editing a custom role changes the permissions it grants, which affects all users assigned to that role.
-
-### Can team Leaders manage team membership without being organization Admins?
-
-Yes, team Leaders have the ability to manage team membership, including adding and removing members, without needing organization-level Admin privileges. This allows for delegation of team management responsibilities.
-
-### How do I manage Grepr deployments and pipelines using IaS or Infrastructure as Code?
-
-Grepr has an open-source Terraform provider that you can use to manage pipelines via git workflows and using infrastructure-as-code.

package/build/dist/docs-index/5c686425-f12c-4c61-8287-2471d7169e42.txt

@@ -1,39 +0,0 @@
-# Update a SumoLogic integration.
-
-**PUT** `/v1/integrations/sumo/{id}`
-
-**Operation ID**: `update_17`
-**Summary**: Update a SumoLogic integration.
-Updates an integration to connect to SumoLogic. The version should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.
-
-## Tags
-- Sumo Logic Integration
-## Parameters
-
-- **id** (required) - path
-  - Type: string
-
-## Request Body
-
-**Content-Type**: `application/json`
-
-**Schema**: `WriteSumo`
-
-## Responses
-
-### 200
-
-Integration updated successfully
-
-- **Content-Type**: `application/json` / `ReadSumo`
-### 401
-
-Unauthorized
-
-### 404
-
-Integration not found.
-
-### 409
-
-Integration was modified or deleted concurrently.