{ "components": { "schemas": { "abs.SecretsConfig": { "description": "Sentinel Output Secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" }, "tenant_id": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "abs.SettingsConfig": { "properties": { "account_url": { "description": "Represents your storage account in Azure. Typically of the format https://{account}.blob.core.windows.net.", "type": "string" }, "batch_config": { "$ref": "#/components/schemas/batch_config.BatchConfig" }, "compression": { "description": "The compression method to be applied to the data before storing in Azure", "type": "string" }, "container": { "description": "A container organizes a set of blobs, similar to a directory in a file system.", "type": "string" }, "format_config": { "$ref": "#/components/schemas/formatter.FormatConfig" }, "partition_format": { "description": "Directory structure used to partition stored objects. Options: simple date (e.g., '2024/01/01'), hive compliant (e.g., 'year=2024/month=01/day=01'), and flat hive compliant (e.g., 'dt=2024-01-01').", "type": "string" }, "prefix": { "description": "An optional prefix for Azure object keys to organize data within the container", "type": "string" } }, "type": "object" }, "add.ArgumentsConfig": { "properties": { "key": { "description": "The key to add to the record", "type": "string" }, "value": { "description": "The value to add to the record" } }, "type": "object" }, "add_id.ArgumentsConfig": { "properties": { "key": { "description": "The key to add to the record with id value", "type": "string" }, "type": { "description": "The type of the identifier", "type": "string" } }, "type": "object" }, "admin_logs.SecretsConfig": { "properties": { "integration_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "integration_key", "secret_key" ], "type": "object" }, "admin_logs.SettingsConfig": { "properties": { "host": { "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "host" ], "type": "object" }, "aiven_service_logs.SecretsConfig": { "description": "Aiven Service Logs secrets", "properties": { "auth_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "aiven_service_logs.SettingsConfig": { "description": "Aiven Service Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "project": { "description": "The Aiven project name", "type": "string" }, "service": { "description": "The Aiven service name", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "alerts.AlertCategory": { "enum": [ "Security", "Compliance", "Operational", "Data Quality" ], "type": "string", "x-enum-varnames": [ "SecurityAlert", "ComplianceAlert", "OperationalAlert", "DataQualityAlert" ] }, "alerts.AlertGranularity": { "enum": [ "pipeline", "billing_account", "organization" ], "type": "string", "x-enum-varnames": [ "GranularityPipeline", "GranularityBillingAccount", "GranularityOrganization" ] }, "alerts.AlertHouse": { "enum": [ "Metrics", "Logs", "Billing" ], "type": "string", "x-enum-varnames": [ "HouseMetrics", "HouseLogs", "HouseTraces" ] }, "alerts.AlertMeta": { "properties": { "category": { "$ref": "#/components/schemas/alerts.AlertCategory" }, "config": {}, "description": { "type": "string" }, "granularity": { "$ref": "#/components/schemas/alerts.AlertGranularity" }, "house": { "$ref": "#/components/schemas/alerts.AlertHouse" }, "internal": { "type": "boolean" }, "name": { "type": "string" }, "tier": { "type": "integer" }, "type_id": { "type": "string" } }, "type": "object" }, "arize_audit_logs.SecretsConfig": { "description": "Arize authenticated audit logs secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "arize_audit_logs.SettingsConfig": { "description": "Arize authenticated audit logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from.", "type": "string" }, "interval_seconds": { "description": "Time interval in seconds between consecutive GraphQL API calls", "type": "integer" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source", "type": "boolean" } }, "type": "object" }, "auth_logs.SecretsConfig": { "properties": { "integration_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "integration_key", "secret_key" ], "type": "object" }, "auth_logs.SettingsConfig": { "properties": { "host": { "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "host" ], "type": "object" }, "authenticationtypes.AuthenticationMethod": { "properties": { "confirmed": { "type": "boolean" }, "created_at": { "type": "string" }, "credential_backed_up": { "type": "boolean" }, "credential_device_type": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "key_id": { "type": "string" }, "link_id": { "type": "string" }, "name": { "type": "string" }, "phone_number": { "type": "string" }, "public_key": { "type": "string" }, "type": { "type": "string" }, "user_agent": { "type": "string" } }, "type": "object" }, "authenticationtypes.MFAEnrollmentTicket": { "properties": { "ticket_id": { "type": "string" }, "ticket_url": { "type": "string" } }, "type": "object" }, "authenticationtypes.TokenResponse": { "properties": { "access_token": { "type": "string" }, "email": { "type": "string" }, "expires_in": { "type": "integer" }, "id_token": { "type": "string" }, "refresh_token": { "type": "string" }, "token_type": { "type": "string" } }, "type": "object" }, "aws_guardduty.SecretsConfig": { "description": "Aws Guardduty secrets", "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "aws_guardduty.SettingsConfig": { "description": "AWS Guardduty settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "region": { "description": "The AWS region where GuardDuty is enabled.", "type": "string" }, "role_arn": { "description": "The ARN of the IAM role to assume for accessing GuardDuty.", "type": "string" }, "severity": { "description": "Filter findings by severity levels.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "aws_s3.SecretsConfig": { "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "aws_s3.SettingsConfig": { "description": "AWS S3 settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of data upto now would be performed on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "bucket": { "description": "Name of the S3 bucket.", "type": "string" }, "compression": { "description": "Compression format of the S3 objects.", "type": "string" }, "format": { "description": "File format of the S3 objects.", "type": "string" }, "partition_format": { "description": "Partition format of your S3 bucket. Options: hive compliant ('year=2024/month=01/day=01'), flat hive compliant ('dt=2024-01-01'), or simple date ('2024/01/01').", "type": "string" }, "prefix": { "description": "Prefix of the S3 object keys to read.", "type": "string" }, "record_location": { "description": "Location of the record in the JSON object. This can be ignored if the record is not in JSON format. Leave empty if you want the entire record.", "type": "string" }, "region": { "description": "AWS Region of your bucket.", "type": "string" }, "role_arn": { "description": "Role ARN to assume when reading from S3.", "type": "string" } }, "type": "object" }, "awssqsoutput.QueueType": { "description": "The type of SQS queue to use. Can be either \"standard\" or \"fifo\".", "enum": [ "standard", "fifo" ], "type": "string", "x-enum-varnames": [ "QueueTypeStandard", "QueueTypeFIFO" ] }, "awssqsoutput.SettingsConfig": { "description": "SQS Output Settings", "properties": { "message_group_id": { "description": "The message group ID for FIFO queues. This is required for FIFO queues.", "type": "string" }, "queue_type": { "$ref": "#/components/schemas/awssqsoutput.QueueType" }, "queue_url": { "description": "The URL of the SQS queue to poll for messages.", "type": "string" }, "region": { "description": "The AWS region where the SQS queue is located.", "type": "string" }, "role_arn": { "description": "The ARN of the IAM role to assume for accessing the SQS queue.", "type": "string" } }, "type": "object" }, "awssqss3.SettingsConfig": { "description": "AWS SQS S3 settings", "properties": { "compression": { "description": "Compression format of the S3 objects.", "type": "string" }, "format": { "description": "File format of the S3 objects.", "type": "string" }, "queue_url": { "description": "The URL of the SQS queue to poll for messages.", "type": "string" }, "record_location": { "description": "Location of the record in the object. Applies only for JSON objects. Leave empty for the entire record.", "type": "string" }, "region": { "description": "The AWS region where the SQS queue is located.", "type": "string" }, "role_arn": { "description": "The ARN of the IAM role to assume for accessing the SQS queue.", "type": "string" }, "uses_sns": { "description": "Uses AWS SNS in the middle of S3 and SQS for fan-out usecases.", "type": "boolean" }, "with_metadata": { "description": "Whether to include S3 object metadata in the output.", "type": "boolean" } }, "type": "object" }, "axiom.SecretsConfig": { "description": "Axiom Output Secrets", "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "axiom.SettingsConfig": { "description": "Axiom Output Settings", "properties": { "dataset": { "description": "Name of the Axiom dataset in which data will be written", "type": "string" } }, "type": "object" }, "azure_activity_logs.SecretsConfig": { "description": "Microsoft Azure Activity Logs secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "azure_activity_logs.SettingsConfig": { "description": "Microsoft Azure Activity Logs settings", "properties": { "correlation_id": { "description": "The correlation ID of the log", "type": "string" }, "resource_group_name": { "description": "The name of the resource group", "type": "string" }, "resource_provider": { "description": "The provider of the resource", "type": "string" }, "resource_uri": { "description": "The URI of the resource", "type": "string" }, "subscription_id": { "description": "The subscription ID of the Azure subscription", "type": "string" }, "tenant_id": { "description": "The tenant ID of the Azure AD application", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "azure_blob_storage.SecretsConfig": { "description": "Sentinel Output Secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" }, "tenant_id": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "azure_blob_storage.SettingsConfig": { "properties": { "account_url": { "description": "Represents your storage account in Azure. Typically of the format https://{account}.blob.core.windows.net.", "type": "string" }, "backfill_start_time": { "description": "Starting timestamp for initial data sync. Only processes blobs with a last modified time after this timestamp on the initial sync. If not specified, all available data from the specified prefix will be processed. Incremental syncs automatically continue from the last processed timestamp, scanning from the previous day's partition forward to catch late-arriving data.\nFiles updated in partitions older than the current state's previous prefix will not be detected.", "type": "string" }, "compression": { "description": "The compression format of objects in the Azure container", "type": "string" }, "container": { "description": "A container organizes a set of blobs, similar to a directory in a file system.", "type": "string" }, "format": { "description": "File format of the Blob storage objects in Azure.", "type": "string" }, "partition_format": { "description": "Partition format of your Azure container. Options: hive compliant ('year=2024/month=01/day=01'), flat hive compliant ('dt=2024-01-01'), or simple date ('2024/01/01').", "type": "string" }, "prefix": { "description": "An optional prefix for Azure object keys to organize data within the container", "type": "string" }, "record_location": { "description": "Location of the record in the object. Applies only for JSON objects. Leave empty for the entire record.", "type": "string" } }, "type": "object" }, "azure_event_hubs.SecretsConfig": { "description": "Microsoft Event Hubs secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "azure_event_hubs.SettingsConfig": { "description": "Microsoft Event Hubs settings", "properties": { "consumer_group": { "description": "The consumer group name for reading events (default: `$Default`)", "type": "string" }, "event_hub_name": { "description": "The name of the specific Event Hub to consume from", "type": "string" }, "event_hub_namespace": { "description": "The fully qualified namespace URL (e.g., `your-namespace.servicebus.windows.net`)", "type": "string" }, "lookback_duration": { "description": "The duration to look back for events in minutes (default: 60 minutes)", "type": "integer" }, "subscription_id": { "description": "The Azure subscription ID containing your Event Hubs namespace", "type": "string" }, "tenant_id": { "description": "The Azure Entra ID tenant (directory) ID", "type": "string" } }, "type": "object" }, "azure_vnet_flow_logs.SecretsConfig": { "description": "Microsoft Azure Vnet Flow Logs secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "azure_vnet_flow_logs.SettingsConfig": { "description": "Microsoft Azure Vnet Flow Logs settings", "properties": { "prefix": { "type": "string" }, "region": { "description": "The Azure region where the virtual network is located", "type": "string" }, "resource_group_name": { "description": "The name of the resource group containing the virtual network", "type": "string" }, "storage_account_url": { "description": "The Azure storage account URL where flow logs are stored", "type": "string" }, "subscription_id": { "description": "The Azure subscription ID where the virtual network and storage account are located", "type": "string" }, "tenant_id": { "description": "The Azure Entra ID tenant (directory) ID.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "virtual_network_name": { "description": "The name of the virtual network for which flow logs are being collected", "type": "string" } }, "type": "object" }, "backblaze.SecretsConfig": { "properties": { "application_key": { "$ref": "#/components/schemas/models.Secret" }, "application_key_id": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "backblaze.SettingsConfig": { "properties": { "batch_config": { "$ref": "#/components/schemas/batch_config.BatchConfig" }, "bucket": { "description": "The name of the B2 bucket where data will be stored", "type": "string" }, "compression": { "description": "The compression method to be applied to the data before storing in B2", "type": "string" }, "format_config": { "$ref": "#/components/schemas/formatter.FormatConfig" }, "partition_format": { "description": "Directory structure used to partition stored objects. Options: simple date (e.g., '2024/01/01'), hive compliant (e.g., 'year=2024/month=01/day=01'), and flat hive compliant (e.g., 'dt=2024-01-01').", "type": "string" }, "prefix": { "description": "An optional prefix for B2 object keys to organize data within the bucket", "type": "string" }, "region": { "description": "The B2 region/endpoint (e.g., us-west-001)", "type": "string" } }, "type": "object" }, "backblaze_b2.SecretsConfig": { "description": "Backblaze B2 secrets", "properties": { "application_key": { "$ref": "#/components/schemas/models.Secret" }, "application_key_id": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "backblaze_b2.SettingsConfig": { "description": "Backblaze B2 settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from", "type": "string" }, "bucket": { "description": "Name of the B2 bucket", "type": "string" }, "compression": { "description": "Compression format of the B2 objects", "type": "string" }, "format": { "description": "File format of the B2 objects", "type": "string" }, "partition_format": { "description": "Partition format of your B2 bucket. Options: hive compliant ('year=2024/month=01/day=01'), flat hive compliant ('dt=2024-01-01'), or simple date ('2024/01/01').", "type": "string" }, "prefix": { "description": "Prefix of the B2 object keys to read", "type": "string" }, "record_location": { "description": "Location of the record in the object. Applies only for JSON objects. Leave empty for the entire record.", "type": "string" }, "region": { "description": "B2 Region of your bucket (e.g., us-west-001, us-west-002, eu-central-003)", "type": "string" } }, "type": "object" }, "batch_config.BatchConfig": { "description": "controls when a batch of records is sent by limiting the number of records, total size, and maximum time elapsed", "properties": { "batch_data_size": { "type": "integer" }, "batch_record_count": { "type": "integer" }, "publish_rate": { "type": "integer" } }, "type": "object" }, "bigquery.SecretsConfig": { "description": "BigQuery Output Secrets", "properties": { "credentials": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "bigquery.SettingsConfig": { "description": "BigQuery Output Settings", "properties": { "dataset": { "description": "The name of the BigQuery dataset where the table resides", "type": "string" }, "project_id": { "description": "The Google Cloud Project ID where the BigQuery instance is located", "type": "string" }, "table": { "description": "The name of the table where the data will be written", "type": "string" } }, "type": "object" }, "bigquery_input.SecretsConfig": { "description": "BigQuery Input Secrets", "properties": { "credentials_json": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "bigquery_input.SettingsConfig": { "description": "BigQuery Input Settings", "properties": { "dataset": { "description": "The BigQuery dataset ID containing the table", "type": "string" }, "project": { "description": "The GCP project ID containing the BigQuery dataset", "type": "string" }, "query": { "description": "Optional custom query to use instead of table (must include timestamp_column)", "type": "string" }, "table": { "description": "The BigQuery table ID to query data from", "type": "string" }, "timestamp_column": { "description": "The column containing timestamp values used for incremental loading", "type": "string" } }, "type": "object" }, "bitwarden_events.SecretsConfig": { "description": "Bitwarden Events secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "bitwarden_events.SettingsConfig": { "description": "Bitwarden Events settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, will fetch from the most recent data available.", "type": "string" }, "base_url": { "description": "Base URL for self-hosted Bitwarden instance (required if region is SelfHosted)", "type": "string" }, "region": { "description": "Region of the Bitwarden instance: US, EU, or SelfHosted (default: US)", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "box_events.SecretsConfig": { "description": "Box Events secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" }, "enterprise_id": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "box_events.SettingsConfig": { "description": "Box Events secrets", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, data from 1 year ago upto now from box is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "event_type": { "description": "A list of event types to filter by.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "brinqa_audit_logs.SecretsConfig": { "description": "Brinqa Audit Logs secrets", "properties": { "password": { "$ref": "#/components/schemas/models.Secret" }, "username": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "brinqa_audit_logs.SettingsConfig": { "description": "Brinqa Audit Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "hostname": { "description": "The Brinqa environment hostname (e.g., \"ssb.brinqa.net\")", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "bugsnag_org_events.SecretsConfig": { "description": "Bugsnag Org Events secrets", "properties": { "personal_auth_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "bugsnag_org_events.SettingsConfig": { "description": "Bugsnag Org Events settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from.", "type": "string" }, "organization_id": { "description": "Organization ID", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "buildkite_audit_logs.SecretsConfig": { "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "buildkite_audit_logs.SettingsConfig": { "properties": { "backfill_start_time": { "description": "Generate synthetic demo data instead of connecting to the real data source.\nUseSyntheticData bool `json:\"use_synthetic_data\"`\nDate to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "org_slug": { "description": "The URL slug of your Buildkite organizations", "type": "string" } }, "type": "object" }, "buildkite_graphql_input.SecretsConfig": { "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "buildkite_graphql_input.SettingsConfig": { "properties": { "enable_pagination": { "description": "Enable pagination support", "type": "boolean" }, "graphql_query": { "description": "The GraphQL query to execute against the endpoint to fetch data", "type": "string" }, "has_next_page_path": { "description": "JSONPath location to check if there are more pages", "type": "string" }, "interval_seconds": { "description": "Time interval in seconds between consecutive GraphQL API calls", "type": "integer" }, "pagination_cursor_path": { "description": "JSONPath location for pagination cursor/token", "type": "string" }, "record_location": { "description": "JSONPath location of the records array in the GraphQL response", "type": "string" }, "variables": { "description": "GraphQL query variables to pass with each request", "items": { "$ref": "#/components/schemas/monad_graphql_input.Variable" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "cisa_user.SecretsConfig": { "description": "CISA KEV secrets", "type": "object" }, "cisa_user.SettingsConfig": { "description": "CISA KEV settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "cloud_configuration_findings.SecretsConfig": { "description": "Wiz cloud configuration findings secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "cloud_configuration_findings.SettingsConfig": { "description": "Wiz cloud configuration findings settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "endpoint_url": { "description": "Endpoint URL for the Wiz API. Ex: 'https://api.wiz.io/v1/cloud-configuration-findings'.", "type": "string" }, "result": { "description": "Result types for Wiz. Ex: 'PASSED', 'FAILED', 'ERROR', 'NOT ASSESSED'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "severity": { "description": "Severity types for Wiz. Ex: 'CRITICAL', 'HIGH', 'MEDIUM', 'LOW', 'NONE'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "status": { "description": "Status types for Wiz. Ex: 'OPEN', 'RESOLVED', 'REJECTED'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "endpoint_url" ], "type": "object" }, "cloud_logs.SecretsConfig": { "description": "Google Cloud Logs secrets", "properties": { "credentials_json": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "cloud_logs.SettingsConfig": { "description": "Google Cloud Logs settings", "properties": { "enable_proto_payload_parsing": { "description": "Enables automatic parsing of embedded protocol buffer payloads within the input.", "type": "boolean" }, "filter": { "description": "The filter to apply to the logs.", "type": "string" }, "resource_names": { "description": "The resources to query logs from.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "cloud_resource_inventory.SecretsConfig": { "description": "Wiz cloud resource inventory secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "cloud_resource_inventory.SettingsConfig": { "description": "Wiz cloud resource inventory settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, A Wiz report is generated on the first sync. All syncs thereafter will be of incremental data.", "type": "string" }, "cloudPlatform": { "description": "Cloud Platform types for Wiz. Ex: 'AWS', 'AZURE', 'GCP'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "endpoint_url": { "description": "Endpoint URL for the Wiz API. Ex: 'https://api.wiz.io/v1/cloud-resource-inventory'.", "type": "string" }, "entityType": { "description": "Entity types for Wiz.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": false }, "full_snapshot": { "description": "FullSnapshot indicates whether to fetch a full snapshot of the cloud resource inventory.", "type": "boolean" }, "interval": { "description": "Defines how frequently (in hours) the system polls the Wiz API to retrieve updated data. Only applicable when full_snapshot is enabled. The interval timer begins after each sync operation completes.", "type": "integer" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "endpoint_url", "entityType" ], "type": "object" }, "cloud_resource_inventory_reports.SecretsConfig": { "description": "Wiz Cloud Resource Inventory Reports secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "cloud_resource_inventory_reports.SettingsConfig": { "description": "Wiz Cloud Resource Inventory Reports settings", "properties": { "cloudPlatform": { "description": "Cloud Platform types for Wiz. Ex: 'AWS', 'AZURE', 'GCP'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "cron": { "description": "Cron expression for scheduling the input", "type": "string" }, "endpoint_url": { "description": "Endpoint URL for the Wiz API. Ex: 'https://api.wiz.io/v1/cloud-resource-inventory'.", "type": "string" }, "entityType": { "description": "Entity types for Wiz. Ex: 'ACCOUNT', 'REGION', 'VPC', 'SUBNET', 'INSTANCE'.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": false }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "endpoint_url", "entityType" ], "type": "object" }, "cloudflare_ddos_attack_analytics.SecretsConfig": { "description": "Cloudflare DDoS Attack Analytics secrets", "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "cloudflare_ddos_attack_analytics.SettingsConfig": { "description": "Cloudflare DDoS Attack Analytics settings", "properties": { "account_id": { "description": "Cloudflare Account ID", "type": "string" }, "backfill_start_time": { "description": "The date to start fetching data from (RFC3339 format). If not specified, fetches all available data within API retention limits.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "cloudflare_firewall_events.SecretsConfig": { "description": "Cloudflare Firewall Events secrets", "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "cloudflare_firewall_events.SettingsConfig": { "description": "Cloudflare Firewall Events settings", "properties": { "include_bot_fields": { "description": "Include Bot Management fields (requires Enterprise plan with Bot Management add-on)", "type": "boolean" }, "lookback_duration": { "description": "Initial lookback duration for first sync (e.g., \"24h\", \"168h\"). Respects API retention limits.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "zone_id": { "description": "Cloudflare Zone ID", "type": "string" } }, "type": "object" }, "cloudflare_http_requests.SecretsConfig": { "description": "Cloudflare HTTP Requests secrets", "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "cloudflare_http_requests.SettingsConfig": { "description": "Cloudflare HTTP Requests settings", "properties": { "fields": { "description": "Fields to include in the query. Leave empty to use default curated list.\nOnly fields available to your account will be included (validated against API).\nMaximum 50 fields due to API constraints.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "lookback_duration": { "description": "Initial lookback duration for first sync (e.g., \"24h\", \"168h\"). Respects API retention limits.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "zone_id": { "description": "Cloudflare Zone ID", "type": "string" } }, "type": "object" }, "cloudflare_url_scanner.SecretsConfig": { "description": "Cloudflare URL Scanner secrets", "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "cloudflare_url_scanner.SettingsConfig": { "description": "Cloudflare URL Scanner settings", "properties": { "account_id": { "description": "Cloudflare Account ID", "type": "string" }, "backfill_start_time": { "description": "Date to start fetching data from (RFC3339 format). Note: Historical data availability depends on your Cloudflare plan (Free: last 50 scans, Self Serve: 30 days, Enterprise: 12 months, Cloudforce One: unlimited)", "type": "string" }, "filter_my_scans": { "description": "Filter to only show scans created by the current API token", "type": "boolean" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source", "type": "boolean" } }, "type": "object" }, "cloudflare_zero_trust_access_requests.SecretsConfig": { "description": "Cloudflare Zero Trust Access Requests secrets", "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "cloudflare_zero_trust_access_requests.SettingsConfig": { "description": "Cloudflare Zero Trust Access Requests settings", "properties": { "account_id": { "description": "Cloudflare Account ID", "type": "string" }, "backfill_start_time": { "description": "Date to start fetching data from (RFC3339 format)", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source", "type": "boolean" } }, "type": "object" }, "cloudtrail.SettingsConfig": { "description": "AWS Cloudtrail settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of data upto now would be performed on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "bucket": { "description": "The name of the S3 bucket", "type": "string" }, "prefix": { "description": "Prefix of the S3 object keys to read.", "type": "string" }, "region": { "description": "The region of the S3 bucket", "type": "string" }, "role_arn": { "description": "The ARN of the role to assume to access the bucket", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "clumio_audit_logs.SecretsConfig": { "description": "Clumio Audit Trails secrets", "properties": { "access_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "clumio_audit_logs.SettingsConfig": { "description": "Clumio Audit Trails settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "region": { "description": "The region associated with your Clumio account", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "clumio_consolidated_alerts.SecretsConfig": { "description": "Clumio Alerts secrets", "properties": { "access_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "clumio_consolidated_alerts.SettingsConfig": { "description": "Clumio Alerts settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "parent_entity_id": { "description": "The system-generated ID of the parent entity that is associated with the primary entity affected by the alert.", "type": "string" }, "parent_entity_type": { "description": "The system-generated name of the parent entity that is associated with the primary entity affected by the alert.", "type": "string" }, "region": { "description": "The region associated with your Clumio account", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "coda_audit_events.SecretsConfig": { "description": "Coda Audit Events secrets", "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "coda_audit_events.SettingsConfig": { "description": "Coda Audit Events settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "org_id": { "description": "Coda Organization ID.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "common.AuthType": { "description": "Authentication type to use", "enum": [ "personal_access_token", "github_app" ], "type": "string", "x-enum-varnames": [ "AuthTypePersonalAccessToken", "AuthTypeGitHubApp" ] }, "community_edition.SecretsConfig": { "description": "GreyNoise Community Edition secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "community_edition.SettingsConfig": { "description": "GreyNoise Community Edition settings", "properties": { "destination_path": { "description": "DestinationPath is the path where the GreyNoise data will be stored", "type": "string" }, "error_on_rate_limit": { "description": "ErrorOnRateLimit determines if rate limiting should cause an error (true) or return custom response (false)", "type": "boolean" }, "ip_address_path": { "description": "IPAddressPath is the path to a field containing an IP address to look up", "type": "string" }, "no_match_response": { "description": "NoMatchResponse is the value to add when no match is found", "type": "string" }, "omit_metadata": { "type": "boolean" }, "rate_limit_response": { "description": "RateLimitResponse is the value to add when rate limited", "type": "string" } }, "type": "object" }, "community_transforms_internal.TransformConfig": { "properties": { "author": { "type": "string" }, "config": { "additionalProperties": {}, "type": "object" }, "contributors": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "description": { "type": "string" }, "inputs": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "community_transforms_internal.TransformMetadata": { "properties": { "author": { "type": "string" }, "contributors": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "created_at": { "type": "string" }, "description": { "type": "string" }, "inputs": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "last_modified": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "community_transforms_internal.TransformsIndex": { "properties": { "last_updated": { "type": "string" }, "schema_hash": { "description": "Hash of the schema structure", "type": "string" }, "transforms": { "items": { "$ref": "#/components/schemas/community_transforms_internal.TransformMetadata" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "convert_timestamp.ArgumentsConfig": { "properties": { "source_format": { "$ref": "#/components/schemas/convert_timestamp.TimestampFormat" }, "source_format_custom": { "description": "Optional: Custom Go time layout (only if SourceFormat = \"custom\")", "type": "string" }, "source_key": { "description": "Required: JSONPath to source timestamp field", "type": "string" }, "source_timezone": { "description": "Optional: Source timezone (default: UTC)", "type": "string" }, "target_format": { "$ref": "#/components/schemas/convert_timestamp.TimestampFormat" }, "target_format_custom": { "description": "Optional: Custom target format (only if TargetFormat = \"custom\")", "type": "string" }, "target_key": { "description": "Optional: Target field (if empty, overwrites SourceKey)", "type": "string" }, "target_timezone": { "description": "Optional: Target timezone (default: UTC)", "type": "string" } }, "type": "object" }, "convert_timestamp.TimestampFormat": { "description": "Required: Format of source timestamp", "enum": [ "auto", "rfc3339", "rfc3339_nano", "iso8601", "unix", "unix_milli", "unix_nano", "rfc1123", "rfc1123z", "ansic", "date", "time", "datetime", "custom" ], "type": "string", "x-enum-varnames": [ "FormatAuto", "FormatRFC3339", "FormatRFC3339Nano", "FormatISO8601", "FormatUnix", "FormatUnixMilli", "FormatUnixNano", "FormatRFC1123", "FormatRFC1123Z", "FormatANSIC", "FormatDate", "FormatTime", "FormatDateTime", "FormatCustom" ] }, "cortex_xsoar_management_logs.SecretsConfig": { "description": "Palo Alto Cortex Xsoar Management Logs secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "cortex_xsoar_management_logs.SettingsConfig": { "description": "Palo Alto Cortex Xsoar Management Logs settings", "properties": { "api_key_id": { "description": "API Key ID for authentication", "type": "string" }, "backfill_start_time": { "description": "Start time for backfilling data", "type": "string" }, "domain_name": { "description": "Domain name of the Cortex XSOAR instance", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "api_key_id", "domain_name" ], "type": "object" }, "create_key_value_if_key_value.ArgumentsConfig": { "properties": { "key": { "description": "The key to add to the record", "type": "string" }, "key_to_watch": { "description": "The key to watch for", "type": "string" }, "value": { "description": "The value to add to the record" }, "value_to_watch": { "description": "The value to watch for" } }, "type": "object" }, "cribl_http.SecretsConfig": { "description": "Cribl HTTP Output Secrets", "properties": { "auth_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "cribl_http.SettingsConfig": { "description": "Cribl HTTP Output Settings", "properties": { "ingress_address": { "description": "Your group's ingress address found in your group information panel. This is the hostname where your Cribl instance is accessible.", "type": "string" }, "path": { "description": "The path you've set for your HTTP Source's HTTP Event API. This is the endpoint path where data will be sent. Note: You do not need to append `_bulk` to this path as monad already does this for you.", "type": "string" }, "port": { "description": "The port you've set your HTTP Source to listen on. This should be the port number where your Cribl HTTP Source is configured to receive data.", "type": "integer" } }, "type": "object" }, "customer_event_data.SecretsConfig": { "description": "Docusign Customer Event Data secrets", "properties": { "integration_key": { "$ref": "#/components/schemas/models.Secret" }, "rsa_private_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "integration_key", "rsa_private_key" ], "type": "object" }, "customer_event_data.SettingsConfig": { "description": "Docusign Customer Event Data settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from in RFC3339 format. If not specified, a full sync of data upto now would be performed on the first sync (since the previous 7 days). You must specify a backfill time to query for data for a time before 7 days. All syncs thereafter will be incremental.", "type": "string" }, "environment": { "description": "Determines the URI {environment}.docusign.com", "enum": [ "production", "development" ], "type": "string" }, "user_id": { "description": "User id of the Docusign admin", "type": "string" } }, "required": [ "environment", "user_id" ], "type": "object" }, "databricks.AutoLoaderWriteMode": { "type": "object" }, "databricks.CopyIntoWriteMode": { "properties": { "table_name": { "description": "The target Delta table name. Required for copy_into mode. If the table doesn't exist, Monad will create it.", "type": "string" } }, "required": [ "table_name" ], "type": "object" }, "databricks.SecretsConfig": { "description": "Databricks Output Secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "databricks.SettingsConfig": { "description": "Databricks Output Settings", "properties": { "batch_config": { "$ref": "#/components/schemas/batch_config.BatchConfig" }, "catalog": { "description": "The Unity Catalog name", "type": "string" }, "http_path": { "description": "The SQL warehouse HTTP path from connection details (e.g. /sql/1.0/warehouses/abc123)", "type": "string" }, "schema": { "description": "The target schema within the catalog", "type": "string" }, "server_hostname": { "description": "The Databricks workspace hostname (e.g. adb-1234567890.azuredatabricks.net)", "type": "string" }, "volume": { "description": "The Unity Catalog Volume used for staging JSONL files", "type": "string" }, "write_mode": { "$ref": "#/components/schemas/databricks.WriteMode" } }, "required": [ "batch_config", "catalog", "http_path", "schema", "server_hostname", "volume", "write_mode" ], "type": "object" }, "databricks.WriteMode": { "description": "The write mode: copy_into (default) stages files and uses COPY INTO; autoloader stages files for Databricks Autoloader to ingest", "properties": { "auto_loader": { "$ref": "#/components/schemas/databricks.AutoLoaderWriteMode" }, "copy_into": { "$ref": "#/components/schemas/databricks.CopyIntoWriteMode" }, "write_mode": { "enum": [ "autoloader", "copy_into" ], "type": "string" } }, "required": [ "write_mode" ], "type": "object" }, "datadog.SecretsConfig": { "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "datadog.SettingsConfig": { "properties": { "ddsource": { "description": "The integration name associated with your log: the technology from which the log originated. When it matches an integration name, Datadog automatically installs the corresponding parsers and facets.", "type": "string" }, "ddtags": { "description": "Tags associated with your logs.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "domain_url": { "description": "The base domain of the Datadog API (e.g., us5.datadoghq.com). Logs are sent to https://http-intake.logs.\u003cDOMAIN_URL\u003e/api/v2/logs", "type": "string" }, "hostname": { "description": "The name of the originating host of the log.", "type": "string" }, "service": { "description": "The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products.", "type": "string" } }, "type": "object" }, "defender_for_endpoint_alerts.SecretsConfig": { "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "defender_for_endpoint_alerts.SettingsConfig": { "properties": { "category": { "type": "string" }, "severity": { "type": "string" }, "tenant_id": { "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "delimited.DelimiterFormatter": { "properties": { "delimiter": { "type": "string" }, "headers": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "delimiter", "headers" ], "type": "object" }, "drop_key.ArgumentsConfig": { "properties": { "key": { "description": "The key to drop from the record", "type": "string" } }, "type": "object" }, "drop_key_where_value_eq.ArgumentsConfig": { "properties": { "key": { "description": "The key to drop from the record", "type": "string" }, "value": { "description": "The value to drop to check for equality with the record's value" } }, "type": "object" }, "drop_record_where_value_eq.ArgumentsConfig": { "properties": { "key": { "description": "The key which values should be checked", "type": "string" }, "value": { "description": "The value to compare with the record's value" } }, "type": "object" }, "duo_security_activity_logs.SecretsConfig": { "description": "Duo Security Activity Logs secrets", "properties": { "integration_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "integration_key", "secret_key" ], "type": "object" }, "duo_security_activity_logs.SettingsConfig": { "description": "Duo Security Activity Logs settings", "properties": { "host": { "description": "The API hostname for your Duo Security integration.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "host" ], "type": "object" }, "duplicate_key_value_to_key.ArgumentsConfig": { "properties": { "key": { "description": "The key to duplicate from the record", "type": "string" }, "new_key": { "description": "The new key to duplicate the value to", "type": "string" } }, "type": "object" }, "eks_audit_logs.SecretsConfig": { "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "eks_audit_logs.SettingsConfig": { "properties": { "backfill_start_time": { "type": "string" }, "cluster_name": { "type": "string" }, "region": { "type": "string" }, "role_arn": { "type": "string" }, "use_synthetic_data": { "type": "boolean" }, "usesStaticCreds": { "type": "boolean" } }, "type": "object" }, "elasticsearch.AuthTypeEnum": { "description": "The method of authentication to use with the Elasticsearch cluster. Choose between 'api_key' or 'password'.", "enum": [ "api_key", "password" ], "type": "string", "x-enum-varnames": [ "AuthTypeAPI", "AuthTypePwd" ] }, "elasticsearch.ConnectionTypeEnum": { "description": "The type of connection to use with Elasticsearch. Choose between 'cloud_id' for Elastic Cloud or 'url' for direct connection.", "enum": [ "cloud_id", "url" ], "type": "string", "x-enum-varnames": [ "ConnectionTypeCloud", "ConnectionTypeURL" ] }, "elasticsearch.SecretsConfig": { "description": "Elasticsearch Output Secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" }, "password": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "elasticsearch.SettingsConfig": { "description": "Elasticsearch Output Settings", "properties": { "auth_type": { "$ref": "#/components/schemas/elasticsearch.AuthTypeEnum" }, "cloud_id": { "description": "The Cloud ID for connecting to an Elastic Cloud deployment. Required when connection_type is set to 'cloud_id'.", "type": "string" }, "connection_type": { "$ref": "#/components/schemas/elasticsearch.ConnectionTypeEnum" }, "index": { "description": "The name of the Elasticsearch index to write data to. If the index doesn't exist, it will be created automatically.", "type": "string" }, "insecure_skip_verify": { "description": "If set to true, it skips verification of the server's TLS certificate. This is insecure and should only be used for testing purposes.", "type": "boolean" }, "url": { "description": "The URL of the Elasticsearch cluster. Required when connection type is set to 'url'.", "type": "string" }, "username": { "description": "Username for authenticating with the Elasticsearch cluster.", "type": "string" } }, "type": "object" }, "encrypt.AESVariant": { "properties": { "encryption_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "encrypt.AgeVariant": { "properties": { "encryption_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "encrypt.AlgorithmConfig": { "description": "Encryption algorithm configuration", "properties": { "aes": { "$ref": "#/components/schemas/encrypt.AESVariant" }, "age": { "$ref": "#/components/schemas/encrypt.AgeVariant" }, "type": { "description": "\"aes\" or \"age\"", "type": "string" } }, "type": "object" }, "encrypt.ArgumentsConfig": { "properties": { "algorithm": { "$ref": "#/components/schemas/encrypt.AlgorithmConfig" }, "key": { "description": "Key whose value will be encrypted", "type": "string" } }, "type": "object" }, "endor_labs_audit_logs.SecretsConfig": { "description": "Endor Labs Audit Logs secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" }, "api_secret": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key", "api_secret" ], "type": "object" }, "endor_labs_audit_logs.SettingsConfig": { "description": "Endor Labs Audit Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "namespace": { "description": "Your Endor Labs organization namespace (e.g., \"your-org\")", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "namespace" ], "type": "object" }, "enrichment.ConnectorMeta": { "properties": { "auth_type": { "type": "string" }, "config": {}, "connector_category": { "$ref": "#/components/schemas/models.InputConnectorCategory" }, "description": { "type": "string" }, "house": { "type": "string" }, "in_beta": { "type": "boolean" }, "internal": { "type": "boolean" }, "name": { "type": "string" }, "tier": { "type": "integer" }, "type_id": { "type": "string" } }, "type": "object" }, "entra_id.SecretsConfig": { "description": "Microsoft Entra ID secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "entra_id.SettingsConfig": { "description": "Microsoft Entra ID settings", "properties": { "category": { "description": "The Category of logs to query", "type": "string" }, "tenant_id": { "description": "The tenant ID of the Azure AD application", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "workspace_id": { "description": "The workspace ID of the Log Analytics workspace", "type": "string" } }, "type": "object" }, "event.SecretsConfig": { "description": "CrowdStrike EDR event stream secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "event.SettingsConfig": { "description": "CrowdStrike EDR event stream settings", "properties": { "app_name": { "description": "The application name monad uses to connect to the CrowdStrike data stream.\nIt's important that this name is unique to avoid conflicts with other applications\nconnecting to the same stream. You're advised to use a unique identifier for this\napplication. For example, if you have 2 stream input connections they should not both\nbe named 'monad'.", "type": "string" }, "cloud": { "description": "Your cloud type for CrowdStrike. Ex: 'autodiscover', 'us-1', 'us-2', 'eu-1', 'us-gov-1'.", "type": "string" }, "member_cid": { "description": "In environments where an entity (like an MSSP) manages security for multiple clients,\neach client is typically assigned a unique CID. This identifier allows the managing\nentity to access and operate within the specific customer's environment. This is crucial\nfor scenarios where operational isolation between different clients' data and\nconfigurations is necessary.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "flagsmith.Flag": { "properties": { "enabled": { "type": "boolean" }, "featureID": { "type": "integer" }, "featureName": { "type": "string" }, "isDefault": { "type": "boolean" }, "value": {} }, "type": "object" }, "flatten.ArgumentsConfig": { "properties": { "delimiter": { "description": "The delimiter to use when flattening for example flattening an array of assets: _ would result in assets_0, assets_1", "type": "string" }, "key": { "description": "The key to flatten", "type": "string" } }, "type": "object" }, "flattenall.ArgumentsConfig": { "properties": { "delimiter": { "description": "The delimiter to use when flattening for example flattening an array of assets: _ would result in assets_0, assets_1", "type": "string" } }, "type": "object" }, "formatter.FormatConfig": { "description": "The format config to use", "properties": { "Format": { "$ref": "#/components/schemas/formatter.Type" }, "delimited_format": { "$ref": "#/components/schemas/delimited.DelimiterFormatter" }, "json_format": { "$ref": "#/components/schemas/json.JsonFormatter" }, "parquet_format": { "$ref": "#/components/schemas/parquet.ParquetFormatter" } }, "required": [ "Format" ], "type": "object" }, "formatter.Type": { "enum": [ "delimited", "parquet", "json", "delimited", "parquet", "json" ], "type": "string", "x-enum-varnames": [ "Delimited", "Parquet", "Json" ] }, "full_scans.SecretsConfig": { "description": "Socket Full Scans secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "full_scans.SettingsConfig": { "description": "Socket Full Scans settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "org_slug": { "description": "Cron expression for scheduling the input", "type": "string" }, "repo": { "description": "A repository slug to filter full-scans by.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "org_slug" ], "type": "object" }, "geolocus.SecretsConfig": { "description": "Geolocus secrets (currently none required for file-based lookup)", "type": "object" }, "geolocus.SettingsConfig": { "description": "Geolocus settings", "properties": { "destination_path": { "description": "DestinationPath is the path where Geolocus results will be added to each record", "type": "string" }, "ip_address_path": { "description": "IPAddressPath is the path to a field containing an IP address to look up", "type": "string" }, "no_match_response": { "description": "NoMatchResponse is the value to add when no match is found", "type": "string" }, "omit_metadata": { "type": "boolean" } }, "type": "object" }, "github_com_monad-inc_core_pkg_types_models.Alert": { "properties": { "created_at": { "type": "integer" }, "description": { "type": "string" }, "id": { "type": "string" }, "metadata": {}, "name": { "type": "string" }, "organization_id": { "type": "string" }, "resource": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.ResourceReference" }, "rule_id": { "type": "string" }, "rule_type": { "type": "string" }, "severity": { "type": "string" }, "status": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.AlertStatus" } }, "type": "object" }, "github_com_monad-inc_core_pkg_types_models.AlertStatus": { "properties": { "clearing_started_at": { "description": "When clearing began", "type": "integer" }, "resolved_at": { "description": "Unix timestamp when resolved", "type": "integer" }, "state": { "$ref": "#/components/schemas/models.AlertState" } }, "type": "object" }, "github_com_monad-inc_core_pkg_types_models.Organization": { "properties": { "billing_account_id": { "type": "string" }, "connection_id": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "friendly_name": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "parent_organization_id": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "github_com_monad-inc_core_pkg_types_models.Permission": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "github_com_monad-inc_core_pkg_types_models.Quota": { "properties": { "action": { "$ref": "#/components/schemas/models.QuotaAction" }, "billing_account_id": { "type": "string" }, "created_at": { "type": "string" }, "current_usage": { "type": "integer" }, "current_usage_updated_at": { "type": "string" }, "end_at": { "type": "string" }, "id": { "type": "string" }, "limit_amount": { "type": "integer" }, "limit_type": { "$ref": "#/components/schemas/models.QuotaLimitType" }, "limit_unit": { "$ref": "#/components/schemas/models.QuotaLimitUnit" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "start_at": { "type": "string" }, "timeframe": { "$ref": "#/components/schemas/models.QuotaTimeframe" }, "updated_at": { "type": "string" } }, "type": "object" }, "github_com_monad-inc_core_pkg_types_models.ResourceReference": { "properties": { "parent_id": { "description": "e.g., pipeline ID if resource is a node", "type": "string" }, "parent_type": { "description": "For hierarchical resources", "type": "string" }, "resource_id": { "type": "string" }, "resource_type": { "description": "\"pipeline\", \"node\", \"organization\"", "type": "string" } }, "type": "object" }, "github_com_monad-inc_core_pkg_types_models.TimeRange": { "properties": { "end": { "description": "End is the end of the time range (inclusive)", "type": "string" }, "start": { "description": "Start is the beginning of the time range (inclusive)", "type": "string" } }, "type": "object" }, "github_com_monad-inc_core_pkg_types_models.User": { "properties": { "auth_providers": { "items": { "$ref": "#/components/schemas/models.UserAuthProvider" }, "type": "array", "uniqueItems": false }, "created_at": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "updated_at": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "gitlab_issues.SecretsConfig": { "description": "Gitlab Issues secrets", "properties": { "personal_access_token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "personal_access_token" ], "type": "object" }, "gitlab_issues.SettingsConfig": { "description": "Gitlab Issues settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "confidential": { "description": "Confidential to filter issues by confidentiality status. Confidential = true means only show confidential issues.", "type": "boolean" }, "gitlab_url": { "description": "GitLab URL (for Custom-Urls when self hosting. Defaults to https://gitlab.com.)", "type": "string" }, "issue_type": { "description": "IssueType to filter issues by type e.g. issue, incident, etc.", "type": "string" }, "project_id": { "description": "Project ID to get issues for", "type": "string" }, "state": { "description": "State to filter issues by e.g. opened, closed", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "with_label_details": { "description": "Include label details in the response", "type": "boolean" } }, "required": [ "gitlab_url", "project_id" ], "type": "object" }, "gke_audit_logs.SecretsConfig": { "description": "GKE Audit Logs secrets", "properties": { "credentials_json": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "credentials_json" ], "type": "object" }, "gke_audit_logs.SettingsConfig": { "description": "GKE Audit Logs settings", "properties": { "cluster_name": { "description": "The name of the GKE cluster.", "type": "string" }, "location": { "description": "The GCP location (region or zone) where the GKE cluster runs, e.g. us-central1.", "type": "string" }, "project_id": { "description": "The GCP project ID that contains the GKE cluster.", "type": "string" } }, "required": [ "cluster_name", "location", "project_id" ], "type": "object" }, "google_cloud_storage.SecretsConfig": { "description": "Google Cloud Storage secrets", "properties": { "credentials_json": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "google_cloud_storage.SettingsConfig": { "description": "Google Cloud Storage settings", "properties": { "bucket_name": { "description": "The name of the Google Cloud Storage bucket to use", "type": "string" }, "compression": { "description": "Compression format of the Google Cloud Storage objects.", "type": "string" }, "format": { "description": "The format of the files in the bucket, e.g., \"json\", \"csv\", etc.", "type": "string" }, "partition_format": { "description": "Partition format of your bucket. Options: hive compliant ('year=2024/month=01/day=01'), flat hive compliant ('dt=2024-01-01'), or simple date ('2024/01/01').", "type": "string" }, "prefix": { "description": "The prefix to use when reading from the bucket. This is used to filter objects in the bucket.", "type": "string" }, "project_id": { "description": "The Google Cloud project ID to use", "type": "string" }, "record_location": { "description": "Location of the record in the object. Applies only for JSON objects. Leave empty for the entire record.", "type": "string" } }, "type": "object" }, "google_cloud_storage_output.SecretsConfig": { "properties": { "credentials_json": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "google_cloud_storage_output.SettingsConfig": { "properties": { "batch_config": { "$ref": "#/components/schemas/batch_config.BatchConfig" }, "bucket": { "description": "The name of the bucket where data will be stored", "type": "string" }, "compression": { "description": "The compression method to be applied to the data before storing", "type": "string" }, "format": { "$ref": "#/components/schemas/formatter.FormatConfig" }, "partition_format": { "description": "Directory structure used to partition stored objects. Options: simple date (e.g., '2024/01/01'), hive compliant (e.g., 'year=2024/month=01/day=01'), and flat hive compliant (e.g., 'dt=2024-01-01').", "type": "string" }, "prefix": { "description": "An optional prefix for object keys to organize data within the bucket", "type": "string" } }, "type": "object" }, "google_workspace.SecretsConfig": { "description": "Google Workspace Activity secrets", "properties": { "credentials_json": { "$ref": "#/components/schemas/models.Secret" }, "oauth_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "google_workspace.SettingsConfig": { "description": "Google Workspace Activity settings", "properties": { "auth_type": { "description": "Authentication type (service_account or oauth)", "type": "string" }, "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of data from google workspace is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "email": { "description": "Email address to use for authenticating with Google Cloud (required for service_account auth).", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "greenhouse_audit_logs.SecretsConfig": { "description": "Greenhouse Audit Log secrets", "properties": { "harvest_api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "harvest_api_key" ], "type": "object" }, "greenhouse_audit_logs.SettingsConfig": { "description": "Greenhouse Audit Log settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "user_id": { "description": "ID of the user to harvest audit logs for", "type": "string" } }, "required": [ "user_id" ], "type": "object" }, "http.Headers": { "properties": { "header_key": { "type": "string" }, "header_value": { "type": "string" } }, "type": "object" }, "http.PayloadStructure": { "description": "Determines how the payload is structured. 'single' sends each record as a separate request, 'array' sends multiple records as an array, 'wrapped' sends multiple records within a wrapper object.", "enum": [ "single", "array", "wrapped" ], "type": "string", "x-enum-varnames": [ "PayloadStructureSingle", "PayloadStructureArray", "PayloadStructureWrapped" ] }, "http.SecretsConfig": { "description": "HTTP Output Secrets", "properties": { "auth_headers": { "additionalProperties": { "$ref": "#/components/schemas/models.Secret" }, "description": "Authentication headers", "type": "object" } }, "type": "object" }, "http.SettingsConfig": { "description": "HTTP Output Settings", "properties": { "endpoint": { "description": "The full URL of the HTTP endpoint to send data to. Must include the scheme (http or https).", "type": "string" }, "headers": { "description": "Non secret headers", "items": { "$ref": "#/components/schemas/http.Headers" }, "type": "array", "uniqueItems": false }, "max_batch_data_size": { "description": "The maximum size in KB for a single batch of data to be sent in one request. This does not effect the single payload structure.", "type": "integer" }, "max_batch_record_count": { "description": "The maximum number of records to include in a single batch. For single payload structure, this is automatically set to 1. For other payload structures, this determines the maximum number of records sent in a single request.", "type": "integer" }, "method": { "description": "The HTTP method to use for requests (GET, POST, PUT, PATCH, or DELETE).", "type": "string" }, "payload_structure": { "$ref": "#/components/schemas/http.PayloadStructure" }, "rate_limit": { "description": "Maximum number of requests per second to send to the endpoint.", "type": "integer" }, "tls_skip_verify": { "description": "Skip TLS verification.", "type": "boolean" }, "wrapper_key": { "description": "The key to use for wrapping the payload when PayloadStructure is set to 'wrapped'.", "type": "string" } }, "type": "object" }, "individual_alerts.SecretsConfig": { "description": "Clumio Alerts secrets", "properties": { "access_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "individual_alerts.SettingsConfig": { "description": "Clumio Alerts settings", "properties": { "alert_type": { "description": "Filter by alert type (e.g., policy_violated, tag_conflict)", "type": "string" }, "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "embed": { "description": "Embed related resources in the data returned (e.g., read-consolidated-alert)", "type": "string" }, "primary_entity_type": { "description": "Filter by primary entity type (e.g., aws_ebs_volume, vmware_vm)", "type": "string" }, "primary_entity_value": { "description": "Filter by primary entity value (contains search)", "type": "string" }, "region": { "description": "The region associated with your Clumio account", "type": "string" }, "severity": { "description": "Filter by alert severity (error, warning)", "type": "string" }, "status": { "description": "Filter by alert status (active, cleared)", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "inputs.ConnectorMeta": { "properties": { "auth_type": { "type": "string" }, "billing_type": { "$ref": "#/components/schemas/models.BillingType" }, "category": { "$ref": "#/components/schemas/models.InputConnectorCategory" }, "config": {}, "description": { "type": "string" }, "house": { "type": "string" }, "in_beta": { "type": "boolean" }, "internal": { "type": "boolean" }, "is_default": { "type": "boolean" }, "name": { "type": "string" }, "release_date": { "type": "string" }, "tier": { "type": "integer" }, "type_id": { "type": "string" } }, "type": "object" }, "inspector.SecretsConfig": { "description": "AWS Inspector secrets", "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "inspector.SettingsConfig": { "description": "AWS Inspector settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "region": { "description": "The AWS region where Inspector is enabled.", "type": "string" }, "role_arn": { "description": "The ARN of the IAM role to assume for accessing Inspector.", "type": "string" }, "severities": { "description": "Minimum severity level of findings to fetch.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "severityFilter": { "items": { "$ref": "#/components/schemas/types.StringFilter" }, "type": "array" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "issues.SecretsConfig": { "description": "Wiz Issues secrets configuration", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "issues.SettingsConfig": { "description": "Wiz Issues settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, A Wiz report is generated on the first sync. All syncs thereafter will be of incremental data.", "type": "string" }, "control_ids": { "description": "@Description Filter Issues created by specific control IDs", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "has_note": { "description": "@Description Filter Issues with or without a note", "enum": [ "has_note", "does_not_have_note", "do_not_filter" ], "type": "string" }, "has_remediation": { "description": "@Description Filter Issues with or without remediation", "enum": [ "has_remediation", "does_not_have_remediation", "do_not_filter" ], "type": "string" }, "has_service_ticket": { "description": "@Description Filter Issues with or without related service ticket", "enum": [ "has_service_ticket", "does_not_have_service_ticket", "do_not_filter" ], "type": "string" }, "issue_ids": { "description": "@Description Filter only Issues that match these specific IDs", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "issue_types": { "description": "@Description Filter by Issue type", "items": { "enum": [ "TOXIC_COMBINATION", "THREAT_DETECTION", "CLOUD_CONFIGURATION" ], "type": "string" }, "type": "array", "uniqueItems": false }, "project_ids": { "description": "@Description Filter Issues associated with specific project IDs", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "related_entity_id": { "description": "@Description Filter by related entity ids", "type": "string" }, "resolution_reasons": { "description": "@Description Filter Issues by resolution reason", "items": { "enum": [ "CONTROL_CHANGED", "CONTROL_DISABLED", "CONTROL_DELETED", "EXCEPTION", "FALSE_POSITIVE", "WONT_FIX", "OBJECT_DELETED", "ISSUE_FIXED" ], "type": "string" }, "type": "array", "uniqueItems": false }, "risk_equals_all": { "description": "@Description Filters Issues by risk type according to Wiz-defined types of risk\n@Description Use the risk ID and not the risk name\n@Description All specified risks must be present", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "risk_equals_any": { "description": "@Description Filters Issues by risk type according to Wiz-defined types of risk\n@Description Use the risk ID and not the risk name", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "search_query": { "description": "@Description Free text search on Issue title or object name\n@Description Returns NULL if no match is found", "type": "string" }, "security_scan": { "description": "@Description Filter by security scan source", "type": "string" }, "severities": { "description": "@Description Filter Issues according to Control severity", "items": { "enum": [ "INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "type": "string" }, "type": "array", "uniqueItems": false }, "stack_layers": { "description": "@Description Filter Issues from specific stack layers", "items": { "enum": [ "APPLICATION_AND_DATA", "CI_CD", "SECURITY_AND_IDENTITY", "COMPUTE_PLATFORMS", "CODE", "CLOUD_ENTITLEMENTS", "DATA_STORES" ], "type": "string" }, "type": "array", "uniqueItems": false }, "status": { "description": "@Description Filter by Issue handling status\n@Description Default: OPEN", "items": { "enum": [ "OPEN", "IN_PROGRESS", "RESOLVED", "REJECTED" ], "type": "string" }, "type": "array", "uniqueItems": false }, "tenant_data_center": { "description": "DataCenter represents the tenant's data center location\n@Description Enter a tenant data center, e.g., \"us1\", \"us2\", \"us3\"\n@Description Find your tenant data center on the Tenant Info page in Wiz, or request it from your Wiz customer contact", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "tenant_data_center" ], "type": "object" }, "issues_report.SecretsConfig": { "description": "Wiz Issues secrets configuration", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "issues_report.SettingsConfig": { "description": "Wiz Issues settings", "properties": { "control_ids": { "description": "@Description Filter Issues created by specific control IDs", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "cron": { "description": "Cron string for scheduling the ingest of your input", "type": "string" }, "has_note": { "description": "@Description Filter Issues with or without a note", "enum": [ "has_note", "does_not_have_note", "do_not_filter" ], "type": "string" }, "has_remediation": { "description": "@Description Filter Issues with or without remediation", "enum": [ "has_remediation", "does_not_have_remediation", "do_not_filter" ], "type": "string" }, "has_service_ticket": { "description": "@Description Filter Issues with or without related service ticket", "enum": [ "has_service_ticket", "does_not_have_service_ticket", "do_not_filter" ], "type": "string" }, "issue_ids": { "description": "@Description Filter only Issues that match these specific IDs", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "issue_types": { "description": "@Description Filter by Issue type", "items": { "enum": [ "TOXIC_COMBINATION", "THREAT_DETECTION", "CLOUD_CONFIGURATION" ], "type": "string" }, "type": "array", "uniqueItems": false }, "project_ids": { "description": "@Description Filter Issues associated with specific project IDs", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "related_entity_id": { "description": "@Description Filter by related entity ids", "type": "string" }, "resolution_reasons": { "description": "@Description Filter Issues by resolution reason", "items": { "enum": [ "CONTROL_CHANGED", "CONTROL_DISABLED", "CONTROL_DELETED", "EXCEPTION", "FALSE_POSITIVE", "WONT_FIX", "OBJECT_DELETED", "ISSUE_FIXED" ], "type": "string" }, "type": "array", "uniqueItems": false }, "risk_equals_all": { "description": "@Description Filters Issues by risk type according to Wiz-defined types of risk\n@Description Use the risk ID and not the risk name\n@Description All specified risks must be present", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "risk_equals_any": { "description": "@Description Filters Issues by risk type according to Wiz-defined types of risk\n@Description Use the risk ID and not the risk name", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "search_query": { "description": "@Description Free text search on Issue title or object name\n@Description Returns NULL if no match is found", "type": "string" }, "security_scan": { "description": "@Description Filter by security scan source", "type": "string" }, "severities": { "description": "@Description Filter Issues according to Control severity", "items": { "enum": [ "INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "type": "string" }, "type": "array", "uniqueItems": false }, "stack_layers": { "description": "@Description Filter Issues from specific stack layers", "items": { "enum": [ "APPLICATION_AND_DATA", "CI_CD", "SECURITY_AND_IDENTITY", "COMPUTE_PLATFORMS", "CODE", "CLOUD_ENTITLEMENTS", "DATA_STORES" ], "type": "string" }, "type": "array", "uniqueItems": false }, "status": { "description": "@Description Filter by Issue handling status\n@Description Default: OPEN", "items": { "enum": [ "OPEN", "IN_PROGRESS", "RESOLVED", "REJECTED" ], "type": "string" }, "type": "array", "uniqueItems": false }, "tenant_data_center": { "description": "DataCenter represents the tenant's data center location\n@Description Enter a tenant data center, e.g., \"us1\", \"us2\", \"us3\"\n@Description Find your tenant data center on the Tenant Info page in Wiz, or request it from your Wiz customer contact", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "tenant_data_center" ], "type": "object" }, "jq.ArgumentsConfig": { "properties": { "key": { "description": "Optional key to store result under", "type": "string" }, "query": { "description": "The raw query string from config", "type": "string" } }, "type": "object" }, "json.FormatType": { "enum": [ "nested", "array", "line" ], "type": "string", "x-enum-varnames": [ "Nested", "Array", "Line" ] }, "json.JsonFormatter": { "properties": { "key": { "type": "string" }, "type": { "$ref": "#/components/schemas/json.FormatType" } }, "required": [ "type" ], "type": "object" }, "kafka.SecretsConfig": { "description": "Kafka Output Secrets", "properties": { "ca_certificate": { "$ref": "#/components/schemas/models.Secret" }, "client_certificate": { "$ref": "#/components/schemas/models.Secret" }, "client_key": { "$ref": "#/components/schemas/models.Secret" }, "password": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "kafka.SettingsConfig": { "description": "Kafka Output Settings", "properties": { "acks": { "$ref": "#/components/schemas/kafka.acks" }, "batch_config": { "$ref": "#/components/schemas/batch_config.BatchConfig" }, "bootstrap_servers": { "description": "Comma-separated list of Kafka broker addresses (host:port)", "type": "string" }, "compression_type": { "$ref": "#/components/schemas/kafka.compressionType" }, "headers": { "description": "Static headers to add to each Kafka message", "items": { "$ref": "#/components/schemas/kafka.kafkaHeader" }, "type": "array", "uniqueItems": false }, "message_key_field": { "description": "JSON field path to extract as the Kafka message key (uses gjson syntax)", "type": "string" }, "retries": { "description": "Number of retry attempts for failed writes", "type": "integer" }, "sasl_mechanism": { "$ref": "#/components/schemas/kafka.saslMechanism" }, "security_protocol": { "$ref": "#/components/schemas/kafka.securityProtocol" }, "topic": { "description": "The Kafka topic to publish messages to", "type": "string" }, "username": { "description": "Username for SASL authentication", "type": "string" } }, "type": "object" }, "kafka.acks": { "description": "Acknowledgment level (0=none, 1=leader only, all=all replicas)", "enum": [ "0", "1", "all" ], "type": "string", "x-enum-comments": { "acksAll": "All in-sync replicas acknowledgment", "acksNone": "No acknowledgment", "acksOne": "Leader acknowledgment only" }, "x-enum-varnames": [ "acksNone", "acksOne", "acksAll" ] }, "kafka.compressionType": { "description": "Compression codec for messages (none, gzip, snappy, lz4, zstd)", "enum": [ "none", "gzip", "snappy", "lz4", "zstd" ], "type": "string", "x-enum-varnames": [ "compressionNone", "compressionGzip", "compressionSnappy", "compressionLz4", "compressionZstd" ] }, "kafka.kafkaHeader": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "kafka.saslMechanism": { "description": "SASL authentication mechanism (PLAIN, SCRAM-SHA-256, SCRAM-SHA-512)", "enum": [ "PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512" ], "type": "string", "x-enum-varnames": [ "saslMechanismPlain", "saslMechanismScramSHA256", "saslMechanismScramSHA512" ] }, "kafka.securityProtocol": { "description": "Security protocol for broker connections (NONE, SASL_PLAINTEXT, SASL_SSL, SSL)", "enum": [ "NONE", "SASL_PLAINTEXT", "SASL_SSL", "SSL" ], "type": "string", "x-enum-varnames": [ "securityProtocolNone", "securityProtocolSASLPlaintext", "securityProtocolSASLSSL", "securityProtocolSSL" ] }, "koi_audit_logs.SecretsConfig": { "description": "Koi audit logs secrets", "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_token" ], "type": "object" }, "koi_audit_logs.SettingsConfig": { "description": "Koi audit logs settings", "properties": { "audit_log_types": { "description": "Filter audit logs by type(s). Available types: approval_requests, devices, endpoints, extensions, firewall. Leave empty to fetch all types.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "backfill_start_time": { "description": "BackfillStartTime is an optional ISO8601 timestamp to start fetching from. If not set, the input starts from the current time (no historical backfill). Example: \"2024-01-01T00:00:00Z\"", "type": "string" }, "base_url": { "description": "Base URL for the Koi API (default: https://api.prod.koi.security)", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "kv_lookup.SecretsConfig": { "description": "KVLookup enrichment settings", "type": "object" }, "kv_lookup.SettingsConfig": { "description": "KVLookup enrichment settings", "properties": { "destination_key": { "description": "DestinationKey is the path where the result will be stored in the record", "type": "string" }, "error_on_missing_key": { "description": "ErrorOnMissingKey If true, throw an error when key is not found in the KV store", "type": "boolean" }, "join_path": { "description": "JoinPath is the path to a field whose values will be used as the lookup keys", "type": "string" }, "kv_lookup_output_id": { "description": "KVLookupOutputID is the id of the KV lookup output to join with", "type": "string" }, "no_match_response": { "description": "NoMatchResponse is the value to add to the record when no match is found", "type": "string" }, "omit_metadata": { "type": "boolean" } }, "type": "object" }, "kv_lookup_output.SecretsConfig": { "description": "KV Lookup Output Secrets", "type": "object" }, "kv_lookup_output.SettingsConfig": { "description": "KV Lookup Output Settings", "properties": { "key_field": { "description": "The field in the incoming record to use as the key", "type": "string" }, "ttl": { "description": "Time-to-live in hours for stored key-value pairs (0 means no expiration)", "type": "integer" }, "value_field": { "description": "The field in the incoming record to use as the value", "type": "string" } }, "type": "object" }, "kvlookup.GetMetadataResponse": { "properties": { "bytes": { "type": "integer" }, "last_ingested_time": { "type": "string" }, "max_bytes": { "type": "integer" }, "number_of_keys": { "type": "integer" }, "ttl": { "type": "integer" } }, "type": "object" }, "kvlookup.KVEntry": { "properties": { "last_updated_at": { "type": "string" }, "value": { "items": { "type": "integer" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "leafconditions.Info": { "properties": { "config_meta": {}, "description": { "type": "string" }, "name": { "type": "string" }, "type_id": { "type": "string" } }, "type": "object" }, "log_analytics_query.SecretsConfig": { "description": "Microsoft Log Analytics Query secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "log_analytics_query.SettingsConfig": { "description": "Microsoft Log Analytics Query settings", "properties": { "query": { "description": "The query to run against the Log Analytics workspace", "type": "string" }, "tenant_id": { "description": "The tenant ID of the Azure AD application", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "workspace_id": { "description": "The workspace ID of the Log Analytics workspace", "type": "string" } }, "type": "object" }, "mask.ArgumentsConfig": { "properties": { "key": { "description": "Key whose value will be masked", "type": "string" }, "mode": { "$ref": "#/components/schemas/mask.ModeConfig" } }, "type": "object" }, "mask.DeterministicVariant": { "properties": { "hash_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "mask.ModeConfig": { "description": "Masking mode. Simple replaces values with a fixed mask. Deterministic produces a stable, correlatable output using HMAC.", "properties": { "deterministic": { "$ref": "#/components/schemas/mask.DeterministicVariant" }, "simple": { "$ref": "#/components/schemas/mask.SimpleVariant" }, "type": { "description": "Type of masking mode. \"simple\" or \"deterministic\". Defaults to \"simple\".", "type": "string" } }, "type": "object" }, "mask.SimpleVariant": { "type": "object" }, "math_multiply_with_value.ArgumentsConfig": { "properties": { "key": { "description": "The Key value to multiply", "type": "string" }, "new_key": { "description": "The key to store the result of the multiplication", "type": "string" }, "value": { "description": "The value to multiply with" } }, "type": "object" }, "meraki_config_logs.SecretsConfig": { "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "meraki_config_logs.SettingsConfig": { "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of data from google workspace is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "org_id": { "description": "URL of the organization", "type": "string" }, "region": { "description": "api.meraki.com/api/v1 for most parts of the world. Different countries may have different base URIs", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "microsoft_365_generic.SecretsConfig": { "description": "Microsoft 365 secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "microsoft_365_generic.SettingsConfig": { "description": "Microsoft 365 settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "tenant_id": { "description": "The Azure Entra ID tenant (directory) ID", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "models.APIKey": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "expiration_time": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "role_id": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.APIKeyList": { "properties": { "api_keys": { "items": { "$ref": "#/components/schemas/models.APIKey" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.APIKeyWithToken": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "expiration_time": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "role_id": { "type": "string" }, "token": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.AlertRule": { "properties": { "active": { "type": "boolean" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "pipeline_ids": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "rule_config": { "additionalProperties": {}, "type": "object" }, "severity": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.AlertRuleList": { "properties": { "alert_rules": { "items": { "$ref": "#/components/schemas/models.AlertRule" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.AlertState": { "enum": [ "FIRING", "RESOLVED" ], "type": "string", "x-enum-varnames": [ "AlertStatusFiring", "AlertStatusResolved" ] }, "models.BillingAccount": { "properties": { "billing_email": { "type": "string" }, "created_at": { "type": "string" }, "current_billing_cycle_end": { "type": "string" }, "current_billing_cycle_start": { "type": "string" }, "deleted_at": { "type": "string" }, "description": { "type": "string" }, "has_payment_method": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "next_product": { "$ref": "#/components/schemas/models.BillingProduct" }, "next_product_id": { "type": "string" }, "product": { "$ref": "#/components/schemas/models.BillingProduct" }, "product_change_after": { "type": "string" }, "product_id": { "type": "string" }, "status": { "type": "string" }, "suspend_on": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.BillingAccountList": { "properties": { "billing_accounts": { "items": { "$ref": "#/components/schemas/models.BillingAccount" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.BillingAccountPermission": { "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" }, "models.BillingAccountRole": { "properties": { "billing_account_id": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "updated_at": { "type": "string" }, "users": { "items": { "$ref": "#/components/schemas/models.BillingAccountRoleUser" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.BillingAccountRoleUser": { "properties": { "email": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "models.BillingProduct": { "properties": { "contact_email": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "features": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "id": { "type": "string" }, "is_default": { "type": "boolean" }, "name": { "type": "string" }, "product_type": { "$ref": "#/components/schemas/models.BillingProductType" }, "recurring_cost_cents": { "type": "integer" }, "recurring_frequency": { "type": "string" }, "slug": { "type": "string" }, "updated_at": { "type": "string" }, "usage_unit": { "type": "string" }, "usage_unit_cost_cents": { "type": "integer" } }, "type": "object" }, "models.BillingProductList": { "properties": { "billing_products": { "items": { "$ref": "#/components/schemas/models.BillingProduct" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.BillingProductType": { "enum": [ "default", "premium", "custom" ], "type": "string", "x-enum-varnames": [ "BillingProductTypeDefault", "BillingProductTypePremium", "BillingProductTypeCustom" ] }, "models.BillingType": { "enum": [ 0, 1 ], "type": "integer", "x-enum-varnames": [ "BillingTypeBillable", "BillingTypeNone" ] }, "models.ComponentReference": { "properties": { "definition_ref": { "$ref": "#/components/schemas/models.ConnectorInfo" }, "id": { "type": "string" }, "kind": { "$ref": "#/components/schemas/models.ComponentType" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "models.ComponentType": { "enum": [ "transform", "input", "output", "enrichment" ], "type": "string", "x-enum-varnames": [ "ComponentTypeTransform", "ComponentTypeInput", "ComponentTypeOutput", "ComponentTypeEnrichment" ] }, "models.ConditionEvaluatable": { "properties": { "conditions": { "items": { "$ref": "#/components/schemas/models.ConditionEvaluatable" }, "type": "array", "uniqueItems": false }, "config": { "additionalProperties": {}, "description": "leaf config", "type": "object" }, "operator": { "$ref": "#/components/schemas/models.ConditionOperator" }, "type_id": { "description": "Only set for leaf nodes", "type": "string" } }, "type": "object" }, "models.ConditionOperator": { "description": "Only set for logical nodes", "enum": [ "always", "never", "and", "or", "nor", "xor" ], "type": "string", "x-enum-comments": { "ConditionOperatorAlways": "Always true", "ConditionOperatorAnd": "All conditions must be true", "ConditionOperatorNever": "Always false", "ConditionOperatorNor": "None of the conditions should be true", "ConditionOperatorOr": "At least one condition must be true", "ConditionOperatorXor": "Exactly one condition should be true" }, "x-enum-varnames": [ "ConditionOperatorAlways", "ConditionOperatorNever", "ConditionOperatorAnd", "ConditionOperatorOr", "ConditionOperatorNor", "ConditionOperatorXor" ] }, "models.Connection": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "saml_entity_id": { "type": "string" }, "saml_metadata_url": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.ConnectionList": { "properties": { "connections": { "items": { "$ref": "#/components/schemas/models.Connection" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.ConnectorInfo": { "properties": { "house": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "models.ConnectorMeta": { "properties": { "auth_type": { "type": "string" }, "config": {}, "description": { "type": "string" }, "internal": { "type": "boolean" }, "name": { "type": "string" }, "type_id": { "type": "string" } }, "type": "object" }, "models.DataUsage": { "properties": { "bytes": { "type": "integer" }, "records": { "type": "integer" } }, "type": "object" }, "models.ElseAction": { "description": "will default to bypass if left empty on create/update", "enum": [ "bypass", "drop" ], "type": "string", "x-enum-varnames": [ "ElseActionBypass", "ElseActionDrop" ] }, "models.Enrichment": { "properties": { "config": { "$ref": "#/components/schemas/models.EnrichmentConfig" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.EnrichmentConfig": { "properties": { "secrets": { "additionalProperties": {}, "type": "object" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" }, "models.EnrichmentList": { "properties": { "enrichments": { "items": { "$ref": "#/components/schemas/models.Enrichment" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.Input": { "properties": { "config": { "$ref": "#/components/schemas/models.InputConfig" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.InputConfig": { "properties": { "secrets": { "additionalProperties": {}, "type": "object" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" }, "models.InputConnectorCategory": { "enum": [ "Application Security", "Asset Inventory", "Cloud Security", "Compliance", "Data Security", "Email Security", "Endpoint Security", "Healthcare Security", "Identity Security", "Incident Response", "Internet of Things Security", "MDM", "Network Security", "Operational Technology Security", "Physical Security", "SaaS", "Security Architecture", "Security Awareness", "Security Operations", "System Logs", "Threat Intelligence", "Universal", "User and Entity Behavior Analytics", "Vulnerability Management", "Web Application Security" ], "type": "string", "x-enum-varnames": [ "ApplicationSecurity", "AssetInventory", "CloudSecurity", "Compliance", "DataSecurity", "EmailSecurity", "EndpointSecurity", "HealthcareSecurity", "IdentitySecurity", "IncidentResponse", "IoTSecurity", "MDM", "NetworkSecurity", "OperationalTechnologySecurity", "PhysicalSecurity", "SaaS", "SecurityArchitecture", "SecurityAwareness", "SecurityOperations", "SystemLogs", "ThreatIntelligence", "UniversalInputConnector", "UserEntityBehaviorAnalytics", "VulnerabilityManagement", "WebApplicationSecurity" ] }, "models.InputList": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/models.Input" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.ManagedBy": { "enum": [ "customer", "internal", "system" ], "type": "string", "x-enum-varnames": [ "ManagedByCustomer", "ManagedByInternal", "ManagedBySystem" ] }, "models.NodeBackpressure": { "properties": { "bytes": { "type": "integer" }, "records": { "type": "integer" } }, "type": "object" }, "models.NodeComponent": { "properties": { "config": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "models.OrganizationList": { "properties": { "organizations": { "items": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Organization" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.OrganizationUser": { "properties": { "auth_provider": { "$ref": "#/components/schemas/models.UserAuthProvider" }, "connection_id": { "type": "string" }, "created_at": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "inherited": { "type": "boolean" }, "role_id": { "type": "string" }, "role_name": { "type": "string" }, "source_organization_id": { "type": "string" }, "source_organization_name": { "type": "string" }, "updated_at": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "models.OrganizationUserList": { "properties": { "pagination": { "$ref": "#/components/schemas/models.Pagination" }, "users": { "items": { "$ref": "#/components/schemas/models.OrganizationUser" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.Output": { "properties": { "config": { "$ref": "#/components/schemas/models.OutputConfig" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.OutputConfig": { "properties": { "secrets": { "additionalProperties": {}, "type": "object" }, "settings": { "additionalProperties": {}, "type": "object" } }, "type": "object" }, "models.OutputConnectorCategory": { "enum": [ "Incident Management", "Object Storage", "Search \u0026 Analytics", "SIEM", "Universal", "Data Warehouses", "Web Services" ], "type": "string", "x-enum-varnames": [ "IncidentManagement", "ObjectStorage", "SearchAndAnalytics", "SIEM", "UniversalOutputConnector", "Warehouses", "WebServices" ] }, "models.OutputList": { "properties": { "outputs": { "items": { "$ref": "#/components/schemas/models.Output" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.Pagination": { "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" }, "models.PermissionList": { "properties": { "pagination": { "$ref": "#/components/schemas/models.Pagination" }, "permissions": { "items": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Permission" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.Pipeline": { "properties": { "component_tier": { "type": "integer" }, "created_at": { "type": "string" }, "cron_schedule": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "input_id": { "type": "string" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/models.PipelineStatus" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.PipelineConfigV2": { "properties": { "billingAccountId": { "type": "string" }, "component_tier": { "type": "integer" }, "createdAt": { "type": "string" }, "cron_schedule": { "type": "string" }, "description": { "type": "string" }, "edges": { "items": { "$ref": "#/components/schemas/models.PipelineEdge" }, "type": "array", "uniqueItems": false }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "is_synthetic": { "type": "boolean" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "next_cron_run_at": { "type": "string" }, "nodes": { "items": { "$ref": "#/components/schemas/models.PipelineNode" }, "type": "array", "uniqueItems": false }, "organizationId": { "type": "string" }, "organizationName": { "type": "string" }, "retention_policy": { "$ref": "#/components/schemas/models.PipelineRetentionPolicy" }, "status": { "$ref": "#/components/schemas/models.PipelineStatus" }, "updatedAt": { "type": "string" } }, "type": "object" }, "models.PipelineEdge": { "properties": { "conditions": { "$ref": "#/components/schemas/models.ConditionEvaluatable" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "boolean" }, "from_node_instance_id": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "pipeline_id": { "type": "string" }, "to_node_instance_id": { "type": "string" } }, "type": "object" }, "models.PipelineList": { "properties": { "pagination": { "$ref": "#/components/schemas/models.Pagination" }, "pipelines": { "items": { "$ref": "#/components/schemas/models.Pipeline" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.PipelineMetrics": { "properties": { "end_at": { "type": "string" }, "metric": { "type": "string" }, "node_id": { "type": "string" }, "node_slug": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "pipeline_id": { "type": "string" }, "pipeline_name": { "type": "string" }, "resolution": { "type": "string" }, "start_at": { "type": "string" }, "values": { "items": { "$ref": "#/components/schemas/models.PipelineMetricsValue" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.PipelineMetricsValue": { "properties": { "timestamp": { "type": "integer" }, "value": { "type": "number" } }, "type": "object" }, "models.PipelineNode": { "properties": { "component": { "$ref": "#/components/schemas/models.NodeComponent" }, "component_house": { "type": "string" }, "component_id": { "type": "string" }, "component_sub_type": { "type": "string" }, "component_type": { "$ref": "#/components/schemas/models.ComponentType" }, "created_at": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "organization_id": { "type": "string" }, "pipeline_id": { "type": "string" }, "slug": { "type": "string" }, "status": { "$ref": "#/components/schemas/models.PipelineNodeStatus" } }, "type": "object" }, "models.PipelineNodeStatus": { "properties": { "avg_bytes_per_record_egress": { "type": "integer" }, "avg_bytes_per_record_ingress": { "type": "integer" }, "backpressure": { "$ref": "#/components/schemas/models.NodeBackpressure" }, "component_type": { "type": "string" }, "component_type_id": { "type": "string" }, "egress": { "$ref": "#/components/schemas/models.DataUsage" }, "errors": { "type": "integer" }, "ingress": { "$ref": "#/components/schemas/models.DataUsage" }, "last_ingested_time": { "type": "string" }, "last_record_processed_time": { "type": "string" }, "last_updated_at": { "type": "string" }, "node_id": { "type": "string" }, "node_slug": { "type": "string" }, "progress": { "$ref": "#/components/schemas/models.ProgressEntries" }, "status": { "$ref": "#/components/schemas/models.PipelineStatusValue" } }, "type": "object" }, "models.PipelineRetentionPolicy": { "properties": { "stream_age_limit": { "type": "integer" }, "stream_size_limit": { "type": "string" } }, "type": "object" }, "models.PipelineStatus": { "properties": { "average_size_egressed": { "type": "integer" }, "average_size_ingested": { "type": "integer" }, "egress": { "$ref": "#/components/schemas/models.DataUsage" }, "errors": { "type": "integer" }, "ingress": { "$ref": "#/components/schemas/models.DataUsage" }, "last_ingested_time": { "type": "string" }, "last_updated_at": { "type": "string" }, "nodes": { "items": { "$ref": "#/components/schemas/models.PipelineNodeStatus" }, "type": "array", "uniqueItems": false }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "pipeline_id": { "type": "string" }, "pipeline_name": { "type": "string" }, "progress": { "$ref": "#/components/schemas/models.ProgressEntries" }, "status": { "$ref": "#/components/schemas/models.PipelineStatusValue" }, "stream": { "$ref": "#/components/schemas/models.PipelineStreamInfo" } }, "type": "object" }, "models.PipelineStatusValue": { "enum": [ "Unknown", "Pending", "Initializing", "Running", "Disabled", "Erroring", "Throttled" ], "type": "string", "x-enum-varnames": [ "PipelineStatusUnknown", "PipelineStatusPending", "PipelineStatusInitializing", "PipelineStatusRunning", "PipelineStatusDisabled", "PipelineStatusErroring", "PipelineStatusThrottled" ] }, "models.PipelineStreamInfo": { "properties": { "bytes": { "type": "integer" }, "records": { "type": "integer" } }, "type": "object" }, "models.ProgressEntries": { "properties": { "entries": { "items": { "$ref": "#/components/schemas/models.ProgressEntry" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.ProgressEntry": { "properties": { "label": { "$ref": "#/components/schemas/models.ProgressLabel" }, "partition_key": { "description": "PartitionKey is an optional identifier for multi-entity inputs (e.g., \"detector-123\", \"us-east-1\")\nIn a case where we store multiple state timestamps for a singular input we would use this field as a differentiator", "type": "string" }, "ranges": { "description": "Ranges represents the time ranges that have been read by an input node.\nEach range is a tuple of (start, end) timestamps indicating what data has been processed.\nMultiple ranges allow tracking non-contiguous data reads.", "items": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.TimeRange" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.ProgressLabel": { "description": "Label is an optional descriptor that is human-readable and can be displayed in the UI\nIt should mainly be used to contain the field name/path that is used to extract timestamp for a given inputs data", "enum": [ "Last Processed" ], "type": "string", "x-enum-varnames": [ "ProgressLabelLastProcessed" ] }, "models.QuotaAction": { "enum": [ "NONE", "DISABLE" ], "type": "string", "x-enum-varnames": [ "QuotaActionNone", "QuotaActionDisable" ] }, "models.QuotaLimitType": { "enum": [ "egress_bytes", "ingress_bytes" ], "type": "string", "x-enum-varnames": [ "QuotaLimitTypeEgressBytes", "QuotaLimitTypeIngressBytes" ] }, "models.QuotaLimitUnit": { "enum": [ "bytes" ], "type": "string", "x-enum-varnames": [ "QuotaLimitUnitBytes" ] }, "models.QuotaList": { "properties": { "pagination": { "$ref": "#/components/schemas/models.Pagination" }, "quotas": { "items": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Quota" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.QuotaTimeframe": { "enum": [ "month" ], "type": "string", "x-enum-varnames": [ "QuotaTimeframeMonth" ] }, "models.RawConfig": { "additionalProperties": {}, "type": "object" }, "models.RoleWithPermissions": { "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "permissions": { "items": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Permission" }, "type": "array", "uniqueItems": false }, "protected": { "type": "boolean" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.RoleWithPermissionsList": { "properties": { "pagination": { "$ref": "#/components/schemas/models.Pagination" }, "roles": { "items": { "$ref": "#/components/schemas/models.RoleWithPermissions" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.Secret": { "description": "APIKey for GreyNoise Community API", "properties": { "created_at": { "description": "When the secret was created", "type": "string" }, "description": { "description": "The user set Description of the secret", "type": "string" }, "id": { "description": "The ID of the secret", "type": "string" }, "name": { "description": "The user set Name of the secret", "type": "string" }, "organization_id": { "description": "The OrganizationID the secret belongs to", "type": "string" }, "updated_at": { "description": "When the secret was updated", "type": "string" }, "value": { "description": "The value of the secret. This will never be returned to the client but can be used to set new values when used in a request payload.", "type": "string" } }, "type": "object" }, "models.SecretWithComponents": { "properties": { "created_at": { "description": "When the secret was created", "type": "string" }, "description": { "description": "The user set Description of the secret", "type": "string" }, "enrichments": { "items": { "$ref": "#/components/schemas/models.ComponentReference" }, "type": "array", "uniqueItems": false }, "id": { "description": "The ID of the secret", "type": "string" }, "inputs": { "items": { "$ref": "#/components/schemas/models.ComponentReference" }, "type": "array", "uniqueItems": false }, "name": { "description": "The user set Name of the secret", "type": "string" }, "organization_id": { "description": "The OrganizationID the secret belongs to", "type": "string" }, "outputs": { "items": { "$ref": "#/components/schemas/models.ComponentReference" }, "type": "array", "uniqueItems": false }, "transforms": { "items": { "$ref": "#/components/schemas/models.ComponentReference" }, "type": "array", "uniqueItems": false }, "updated_at": { "description": "When the secret was updated", "type": "string" }, "value": { "description": "The value of the secret. This will never be returned to the client but can be used to set new values when used in a request payload.", "type": "string" } }, "type": "object" }, "models.SecretWithComponentsList": { "properties": { "pagination": { "$ref": "#/components/schemas/models.Pagination" }, "secrets": { "items": { "$ref": "#/components/schemas/models.SecretWithComponents" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.StorageTypeCostConfig": { "properties": { "costs": { "items": { "$ref": "#/components/schemas/models.StorageTypeCostEntry" }, "type": "array", "uniqueItems": false }, "organization_id": { "type": "string" } }, "type": "object" }, "models.StorageTypeCostEntry": { "properties": { "cost_per_gb": { "type": "number" }, "id": { "type": "string" }, "storage_type": { "type": "string" } }, "type": "object" }, "models.StorageTypeCostSummary": { "properties": { "total_org_cost_post_filter": { "type": "number" }, "total_org_cost_pre_filter": { "type": "number" }, "total_org_ingest_bytes": { "type": "integer" }, "total_org_ingest_gb": { "type": "number" }, "total_org_output_storage_bytes": { "type": "integer" }, "total_org_output_storage_gb": { "type": "number" } }, "type": "object" }, "models.StorageTypeOutputDetail": { "properties": { "cost_id": { "type": "string" }, "cost_per_gb": { "type": "number" }, "egress_bytes": { "type": "integer" }, "egress_bytes_gb": { "type": "number" }, "num_pipelines": { "type": "integer" }, "pre_filter_bytes": { "type": "integer" }, "pre_filter_bytes_gb": { "type": "number" }, "total_cost_post_filter": { "type": "number" }, "total_cost_pre_filter": { "type": "number" } }, "type": "object" }, "models.StorageTypeSummaryResponse": { "properties": { "cost_summary": { "$ref": "#/components/schemas/models.StorageTypeCostSummary" }, "end_at": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "outputs": { "additionalProperties": { "$ref": "#/components/schemas/models.StorageTypeOutputDetail" }, "type": "object" }, "start_at": { "type": "string" } }, "type": "object" }, "models.StorageTypeTimeSeries": { "properties": { "storage_type": { "type": "string" }, "values": { "items": { "$ref": "#/components/schemas/models.PipelineMetricsValue" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.StorageTypeTimeSeriesResponse": { "properties": { "end_at": { "type": "string" }, "metric": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "resolution": { "type": "string" }, "start_at": { "type": "string" }, "storage_types": { "items": { "$ref": "#/components/schemas/models.StorageTypeTimeSeries" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.Transform": { "properties": { "config": { "$ref": "#/components/schemas/models.TransformConfig" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.TransformConditional": { "properties": { "conditions": { "$ref": "#/components/schemas/models.ConditionEvaluatable" }, "else": { "$ref": "#/components/schemas/models.ElseAction" } }, "type": "object" }, "models.TransformConfig": { "properties": { "conditional": { "$ref": "#/components/schemas/models.TransformConditional" }, "operations": { "items": { "$ref": "#/components/schemas/models.TransformOperation" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.TransformList": { "properties": { "pagination": { "$ref": "#/components/schemas/models.Pagination" }, "transforms": { "items": { "$ref": "#/components/schemas/models.Transform" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.TransformOperation": { "properties": { "arguments": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "operation": { "type": "string" } }, "type": "object" }, "models.TransformsRepositoryList": { "properties": { "pagination": { "$ref": "#/components/schemas/models.Pagination" }, "transforms": { "items": { "$ref": "#/components/schemas/models.TransformsRepositoryTransform" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "models.TransformsRepositoryTransform": { "properties": { "config": { "$ref": "#/components/schemas/models.TransformConfig" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "input_type_id": { "type": "string" }, "name": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.UserAuthProvider": { "properties": { "connection_id": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" }, "provider_id": { "type": "string" }, "user_id": { "type": "string" } }, "type": "object" }, "models.UserOrganization": { "properties": { "billing_account_id": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "friendly_name": { "type": "string" }, "id": { "type": "string" }, "inherited": { "type": "boolean" }, "name": { "type": "string" }, "parent_organization_id": { "type": "string" }, "source_organization_id": { "type": "string" }, "source_organization_name": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "models.UserOrganizationList": { "properties": { "organizations": { "items": { "$ref": "#/components/schemas/models.UserOrganization" }, "type": "array", "uniqueItems": false }, "pagination": { "$ref": "#/components/schemas/models.Pagination" } }, "type": "object" }, "models.UserRoleWithPermissions": { "properties": { "inherited": { "type": "boolean" }, "organization_id": { "type": "string" }, "permissions": { "items": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Permission" }, "type": "array", "uniqueItems": false }, "role_id": { "type": "string" }, "role_name": { "type": "string" }, "source_organization_id": { "type": "string" } }, "type": "object" }, "monad_graphql_input.Variable": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "monad_log.SecretsConfig": { "description": "Monad Log secrets", "type": "object" }, "monad_log.SettingsConfig": { "description": "Monad Log settings", "properties": { "log_type": { "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "mutate_type.ArgumentsConfig": { "properties": { "key": { "description": "The key to mutate the type of", "type": "string" }, "type": { "description": "The new type of the key", "type": "string" } }, "type": "object" }, "mutate_value_where_key_eq.ArgumentsConfig": { "properties": { "key": { "description": "The key to mutate", "type": "string" }, "value": { "description": "The value to mutate to" } }, "type": "object" }, "mutate_value_where_key_eq_and_value_eq.ArgumentsConfig": { "properties": { "key": { "description": "The key to mutate", "type": "string" }, "value": { "description": "The value to check for" }, "value_to_set": { "description": "The value to set if the key and value match" } }, "type": "object" }, "next_gen_siem.SecretsConfig": { "properties": { "auth_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "next_gen_siem.SettingsConfig": { "properties": { "endpoint": { "type": "string" } }, "type": "object" }, "object_storage.SecretsConfig": { "description": "Object Storage Output Secrets", "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "object_storage.SettingsConfig": { "description": "Object Storage Output Settings", "properties": { "batch_config": { "$ref": "#/components/schemas/batch_config.BatchConfig" }, "bucket": { "description": "The name of the object storage bucket where data will be stored", "type": "string" }, "compression": { "description": "The compression method to be applied to the data before storing", "type": "string" }, "endpoint": { "description": "The endpoint URL for the object storage service (e.g., https://fly.storage.tigris.dev, https://minio.example.com)", "type": "string" }, "format_config": { "$ref": "#/components/schemas/formatter.FormatConfig" }, "partition_format": { "description": "Directory structure used to partition stored objects. Options: simple date (e.g., '2024/01/01'), hive compliant (e.g., 'year=2024/month=01/day=01'), and flat hive compliant (e.g., 'dt=2024-01-01').", "type": "string" }, "prefix": { "description": "An optional prefix for object keys to organize data within the bucket", "type": "string" }, "region": { "description": "The region for the object storage service (optional for some providers)", "type": "string" }, "skip_ssl_verification": { "description": "Whether to skip SSL certificate verification (useful for self-signed certificates or development environments)", "type": "boolean" }, "use_path_style": { "description": "Whether to use path-style URLs (bucket.endpoint.com/object vs endpoint.com/bucket/object). Most S3-compatible services require this to be true.", "type": "boolean" } }, "type": "object" }, "object_storage_input.SecretsConfig": { "description": "Object storage secrets", "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "access_key", "secret_key" ], "type": "object" }, "object_storage_input.SettingsConfig": { "description": "Object storage settings", "properties": { "bucket": { "description": "Name of the storage bucket", "type": "string" }, "compression": { "description": "Compression format of the objects", "enum": [ "auto", "gzip", "none" ], "type": "string" }, "endpoint": { "description": "Endpoint URL for the object storage service (e.g., https://minio.example.com, https://s3.amazonaws.com)", "type": "string" }, "format": { "description": "File format of the objects", "enum": [ "json", "jsonl", "wsv" ], "type": "string" }, "partition_format": { "description": "Partition format of your bucket. Options: hive compliant ('year=2024/month=01/day=01'), flat hive compliant ('dt=2024-01-01'), or simple date ('2024/01/01').", "enum": [ "flat hive compliant", "hive compliant", "simple date" ], "type": "string" }, "prefix": { "description": "Prefix that leads to the start of the expected partition. For example: \"/foobar/year=2024/month=01/day=01/\". The prefix is `foobar`.", "type": "string" }, "record_location": { "description": "Location of the record in the object. Applies only for JSON objects. Leave empty for the entire record.", "type": "string" }, "region": { "description": "Optional region for the object storage service. This is often required for services like AWS S3.", "type": "string" }, "skip_ssl_verification": { "description": "Skip SSL verification for self-signed certificates", "type": "boolean" }, "use_path_style": { "description": "Whether to use path-style URLs (bucket.endpoint.com/object vs endpoint.com/bucket/object). Most S3-compatible services require this to be true.", "type": "boolean" } }, "required": [ "bucket", "compression", "endpoint", "format" ], "type": "object" }, "offlineenrollmentlogs.SecretsConfig": { "description": "Duo Security Offline Enrollment Logs secrets", "properties": { "integration_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "integration_key", "secret_key" ], "type": "object" }, "offlineenrollmentlogs.SettingsConfig": { "description": "Duo Security Offline Enrollment Logs settings", "properties": { "host": { "description": "The API hostname for your Duo Security integration.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "host" ], "type": "object" }, "onelogin_events.SecretsConfig": { "description": "Onelogin Events secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "onelogin_events.SettingsConfig": { "description": "Onelogin Events settings", "properties": { "subdomain": { "description": "SubDomain is a placeholder that represents your specific OneLogin subdomain.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "subdomain" ], "type": "object" }, "opal_events.SecretsConfig": { "description": "Opal Events secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "opal_events.SettingsConfig": { "description": "Opal Events settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "openai_audit_logs.SettingsConfig": { "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "opensearch.AuthMode": { "description": "The authentication mode (basic, aws_role)", "enum": [ "basic", "aws_role" ], "type": "string", "x-enum-varnames": [ "AuthModeBasic", "AuthModeAWSRole" ] }, "opensearch.SecretsConfig": { "description": "OpenSearch Output Secrets", "properties": { "password": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "opensearch.SettingsConfig": { "description": "OpenSearch Output Settings", "properties": { "auth_mode": { "$ref": "#/components/schemas/opensearch.AuthMode" }, "index": { "description": "The name of the OpenSearch index to use.", "type": "string" }, "insecure_skip_verify": { "description": "Whether to skip TLS certificate verification (not recommended for production).", "type": "boolean" }, "region": { "description": "The AWS Region where the OpenSearch domain is located", "type": "string" }, "role_arn": { "description": "The AWS IAM Role ARN to assume (used for aws_role auth)", "type": "string" }, "url": { "description": "The URL of the OpenSearch instance (must start with https).", "type": "string" }, "username": { "description": "The username for authenticating with OpenSearch (used for basic auth).", "type": "string" } }, "type": "object" }, "operation.Information": { "properties": { "config": {}, "description": { "type": "string" }, "name": { "type": "string" }, "type_id": { "type": "string" } }, "type": "object" }, "operation_logs.SecretsConfig": { "description": "Zoom Operation Logs secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "operation_logs.SettingsConfig": { "description": "Zoom Operation Logs settings", "properties": { "account_id": { "description": "Account ID for the input", "type": "string" }, "backfill_start_time": { "description": "Date to start fetching data from. If not specified, data from 6 months ago up till now from zoom is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "category_type": { "description": "The category of logs to pull", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "oracle.SettingsConfig": { "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "domain": { "description": "Domain name for the Oracle Cloud service", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "username": { "description": "Username of Oracle Cloud service user with permissions to access the resource", "type": "string" } }, "required": [ "domain", "username" ], "type": "object" }, "org_audit_logs.SecretsConfig": { "description": "GitHub organization audit logs secrets", "properties": { "github_app_private_key": { "$ref": "#/components/schemas/models.Secret" }, "personal_access_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "org_audit_logs.SettingsConfig": { "description": "GitHub organization audit logs settings", "properties": { "auth_type": { "$ref": "#/components/schemas/common.AuthType" }, "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "github_app_installation_id": { "description": "GitHub App Installation ID (required when using GitHub App authentication)", "type": "string" }, "github_client_id": { "description": "GitHub Client ID (alternative to personal access token)", "type": "string" }, "include": { "description": "Event types to include. web: Gets all web (non-git) events. git: Gets git events. all: Gets both.", "type": "string" }, "organization": { "description": "Your GitHub organization name", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "outputs.ConnectorMeta": { "properties": { "auth_type": { "type": "string" }, "billing_type": { "$ref": "#/components/schemas/models.BillingType" }, "category": { "$ref": "#/components/schemas/models.OutputConnectorCategory" }, "config": {}, "description": { "type": "string" }, "house": { "type": "string" }, "in_beta": { "type": "boolean" }, "internal": { "type": "boolean" }, "name": { "type": "string" }, "release_date": { "type": "string" }, "tier": { "type": "integer" }, "type_id": { "type": "string" } }, "type": "object" }, "ownbackup_account_events.SecretsConfig": { "description": "Ownbackup Audit Logs secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "refresh_token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "refresh_token" ], "type": "object" }, "ownbackup_account_events.SettingsConfig": { "description": "Ownbackup Audit Logs settings", "properties": { "region": { "description": "Region of the OwnBackup instance", "enum": [ "app1", "emea1", "uk1", "usgov2", "hipaa1" ], "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "region" ], "type": "object" }, "pagerduty.SecretsConfig": { "description": "PagerDuty Output Secrets", "properties": { "auth_token": { "$ref": "#/components/schemas/models.Secret" }, "routing_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "pagerduty.SettingsConfig": { "description": "PagerDuty Output Settings", "properties": { "alerts_config": { "$ref": "#/components/schemas/pagerduty.alertsConfig" }, "default_event_type": { "$ref": "#/components/schemas/pagerduty.eventType" }, "summary_config": { "$ref": "#/components/schemas/pagerduty.summaryConfig" } }, "type": "object" }, "pagerduty.alertsConfig": { "description": "AlertsConfig contains configuration options that apply only when EventType is set to 'alert'", "properties": { "class": { "description": "Class defines the class/type of the event based on the input source. Defaults to an empty value.", "type": "string" }, "group": { "description": "A cluster or grouping of sources. For example, sources \\\"prod-datapipe-02\\\" and \\\"prod-datapipe-03\\\" might both be part of \\\"prod-datapipe\\\". Applicable if event type is set to alerts. Defaults to an empty value.", "type": "string" }, "severity": { "description": "Indicates the severity of the impact to the affected system. Applicable for you if event type is set to alerts. Defaults to 'critical'.", "type": "string" } }, "type": "object" }, "pagerduty.eventType": { "description": "EventType determines whether events are sent as 'change' or 'alert' events.\nWe recommend reading the docs for this output before making this choice.", "enum": [ "alert", "change" ], "type": "string", "x-enum-varnames": [ "EventTypeAlert", "EventTypeChange" ] }, "pagerduty.summaryConfig": { "description": "SummaryConfig allows customization of event summary messages displayed in PagerDuty", "properties": { "alert_source": { "description": "alertSource is the source identifier for alert events. Defaults to 'monad-platform'.", "type": "string" }, "alert_summary": { "description": "alertSummary is the custom summary message for alert events. Defaults to 'Monad triggered alert event'.", "type": "string" }, "change_source": { "description": "changeSource is the source identifier for change events. Defaults to 'monad-platform'.", "type": "string" }, "change_summary": { "description": "changeSummary is the custom summary message for change events. Defaults to 'Monad triggered change event'.", "type": "string" } }, "type": "object" }, "pagerduty_audit_records.SecretsConfig": { "description": "Pagerduty Audit Records secrets", "properties": { "auth_token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "auth_token" ], "type": "object" }, "pagerduty_audit_records.SettingsConfig": { "description": "Pagerduty Audit Records settings", "properties": { "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "palo_alto_data_security_alerts.SecretsConfig": { "description": "Palo Alto Data Security Alerts secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "palo_alto_data_security_alerts.SettingsConfig": { "description": "Palo Alto Data Security Alerts settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "base_url": { "description": "URL of the organization", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "base_url" ], "type": "object" }, "panther.SecretsConfig": { "properties": { "bearer_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "panther.SettingsConfig": { "properties": { "http_ingest_url": { "type": "string" } }, "type": "object" }, "parquet.ParquetFormatter": { "description": "Configuration for formatting data in Apache Parquet format", "properties": { "schema": { "type": "string" } }, "required": [ "schema" ], "type": "object" }, "polymer.SecretsConfig": { "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "polymer.SettingsConfig": { "properties": { "domain_name": { "description": "TODO: Name of domain added on Polymer Hub portal", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "domain_name" ], "type": "object" }, "postgresql.SecretsConfig": { "properties": { "connection_string": { "$ref": "#/components/schemas/models.Secret" }, "password": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "postgresql.SettingsConfig": { "properties": { "column_names": { "description": "The column names to write data to, must match the root fields of the data\nIf not provided all root fields will be used", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "database": { "description": "The database name to connect to", "type": "string" }, "host": { "description": "The host of the PostgreSQL database", "type": "string" }, "port": { "description": "The port of the PostgreSQL database", "type": "integer" }, "table": { "description": "The table name to write data to", "type": "string" }, "user": { "description": "The user to connect to the PostgreSQL database", "type": "string" } }, "type": "object" }, "postman_audit_logs.SecretsConfig": { "description": "Postman Audit Logs secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "postman_audit_logs.SettingsConfig": { "description": "Postman Audit Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" } }, "type": "object" }, "prometheus.AuthConfig": { "properties": { "basic": { "$ref": "#/components/schemas/prometheus.BasicVariant" }, "bearer": { "$ref": "#/components/schemas/prometheus.BearerVariant" }, "type": { "type": "string" } }, "type": "object" }, "prometheus.BasicVariant": { "properties": { "password": { "$ref": "#/components/schemas/models.Secret" }, "username": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "prometheus.BearerVariant": { "properties": { "bearer_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "prometheus.FieldMetricVariant": { "properties": { "field_name": { "type": "string" } }, "type": "object" }, "prometheus.MetricNameConfig": { "properties": { "field": { "$ref": "#/components/schemas/prometheus.FieldMetricVariant" }, "static": { "$ref": "#/components/schemas/prometheus.StaticMetricVariant" }, "type": { "type": "string" } }, "type": "object" }, "prometheus.SettingsConfig": { "properties": { "auth": { "$ref": "#/components/schemas/prometheus.AuthConfig" }, "endpoint": { "type": "string" }, "label_fields": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "metric_name": { "$ref": "#/components/schemas/prometheus.MetricNameConfig" }, "timestamp_field": { "type": "string" }, "tls_skip_verify": { "type": "boolean" }, "value_field": { "type": "string" } }, "type": "object" }, "prometheus.StaticMetricVariant": { "properties": { "value": { "type": "string" } }, "type": "object" }, "pubsub.SecretsConfig": { "description": "Salesforce Pubsub secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "pubsub.SettingsConfig": { "description": "Salesforce Pubsub settings", "properties": { "domain_url": { "description": "Domain URL for the Salesforce instance", "type": "string" }, "organization_id": { "description": "Organization ID for the Salesforce instance", "type": "string" }, "topic": { "description": "Pub/Sub topic to subscribe to", "type": "string" } }, "type": "object" }, "rename_key.ArgumentsConfig": { "properties": { "key": { "description": "The key to rename", "type": "string" }, "new_key": { "description": "The new key to rename to", "type": "string" } }, "type": "object" }, "rename_key_where_value_eq.ArgumentsConfig": { "properties": { "key": { "description": "The key to rename", "type": "string" }, "new_key": { "description": "The new key to rename to", "type": "string" }, "value": { "description": "The value to check for" } }, "type": "object" }, "responder.ErrorResponse": { "properties": { "additional_details": {}, "code": { "type": "integer" }, "error": { "type": "string" }, "error_type": { "type": "string" } }, "type": "object" }, "rootly_audit_logs.SecretsConfig": { "description": "Rootly Audit Logs secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "rootly_audit_logs.SettingsConfig": { "description": "Rootly Audit Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "routes.AddUserToOrganizationRequest": { "properties": { "role_id": { "type": "string" }, "user_id": { "type": "string" } }, "required": [ "role_id", "user_id" ], "type": "object" }, "routes.CreateOrganizationRequest": { "properties": { "billing_account_id": { "type": "string" }, "description": { "type": "string" }, "friendly_name": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "routes.CreateTransformRequest": { "properties": { "config": { "$ref": "#/components/schemas/routes.TransformConfig" }, "description": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "routes.GetInputResponse": { "properties": { "component_of": { "items": { "$ref": "#/components/schemas/models.Pipeline" }, "type": "array", "uniqueItems": false }, "config": { "$ref": "#/components/schemas/models.InputConfig" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "routes.GetOutputResponse": { "properties": { "component_of": { "items": { "$ref": "#/components/schemas/models.Pipeline" }, "type": "array", "uniqueItems": false }, "config": { "$ref": "#/components/schemas/models.OutputConfig" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "routes.GetTransformResponse": { "properties": { "component_of": { "items": { "$ref": "#/components/schemas/models.Pipeline" }, "type": "array", "uniqueItems": false }, "config": { "$ref": "#/components/schemas/models.TransformConfig" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "routes.InviteUserToOrganizationRequest": { "properties": { "email": { "type": "string" }, "role_id": { "type": "string" } }, "required": [ "email", "role_id" ], "type": "object" }, "routes.LoginRequest": { "properties": { "password": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "routes.TransformConfig": { "properties": { "conditional": { "$ref": "#/components/schemas/models.TransformConditional" }, "operations": { "items": { "$ref": "#/components/schemas/routes.TransformOperation" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routes.TransformOperation": { "properties": { "arguments": { "additionalProperties": {}, "oneOf": [ { "$ref": "#/components/schemas/add.ArgumentsConfig" }, { "$ref": "#/components/schemas/add_id.ArgumentsConfig" }, { "$ref": "#/components/schemas/convert_timestamp.ArgumentsConfig" }, { "$ref": "#/components/schemas/create_key_value_if_key_value.ArgumentsConfig" }, { "$ref": "#/components/schemas/drop_key.ArgumentsConfig" }, { "$ref": "#/components/schemas/drop_key_where_value_eq.ArgumentsConfig" }, { "$ref": "#/components/schemas/drop_record_where_value_eq.ArgumentsConfig" }, { "$ref": "#/components/schemas/duplicate_key_value_to_key.ArgumentsConfig" }, { "$ref": "#/components/schemas/encrypt.ArgumentsConfig" }, { "$ref": "#/components/schemas/flatten.ArgumentsConfig" }, { "$ref": "#/components/schemas/flattenall.ArgumentsConfig" }, { "$ref": "#/components/schemas/jq.ArgumentsConfig" }, { "$ref": "#/components/schemas/mask.ArgumentsConfig" }, { "$ref": "#/components/schemas/math_multiply_with_value.ArgumentsConfig" }, { "$ref": "#/components/schemas/models.RawConfig" }, { "$ref": "#/components/schemas/mutate_type.ArgumentsConfig" }, { "$ref": "#/components/schemas/mutate_value_where_key_eq.ArgumentsConfig" }, { "$ref": "#/components/schemas/mutate_value_where_key_eq_and_value_eq.ArgumentsConfig" }, { "$ref": "#/components/schemas/rename_key.ArgumentsConfig" }, { "$ref": "#/components/schemas/rename_key_where_value_eq.ArgumentsConfig" }, { "$ref": "#/components/schemas/utc_timestamp.ArgumentsConfig" } ], "type": "object" }, "description": { "type": "string" }, "operation": { "type": "string" }, "secrets": { "additionalProperties": {}, "oneOf": [ { "$ref": "#/components/schemas/models.RawConfig" } ], "type": "object" } }, "type": "object" }, "routes.UpdateOrganizationRequest": { "properties": { "description": { "type": "string" }, "friendly_name": { "type": "string" } }, "required": [ "friendly_name" ], "type": "object" }, "routes.UpdatePipelineRequest": { "properties": { "description": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "routes.UpdateTransformRequest": { "properties": { "config": { "$ref": "#/components/schemas/routes.TransformConfig" }, "description": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "routes.UpdateUserInOrganizationRequest": { "properties": { "role_id": { "type": "string" }, "user_auth_provider_id": { "type": "string" } }, "type": "object" }, "routes.UserAuthProvider": { "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "provider_id": { "type": "string" } }, "type": "object" }, "routes.UserWithRoles": { "properties": { "auth_provider": { "$ref": "#/components/schemas/routes.UserAuthProvider" }, "created_at": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "organization_role": { "$ref": "#/components/schemas/models.UserRoleWithPermissions" }, "updated_at": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "routesV2.ApplyConditionRequest": { "properties": { "condition": { "$ref": "#/components/schemas/models.ConditionEvaluatable" }, "record": { "items": { "type": "integer" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV2.ApplyConditionResponse": { "properties": { "result": { "type": "boolean" } }, "type": "object" }, "routesV2.ApplyTransformationRequest": { "properties": { "config": { "$ref": "#/components/schemas/models.TransformConfig" }, "record": { "items": { "type": "integer" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV2.ApplyTransformationResponse": { "properties": { "bytes_after": { "type": "integer" }, "bytes_before": { "type": "integer" }, "percentage_change": { "type": "number" }, "records": { "items": { "items": { "type": "integer" }, "type": "array" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV2.CreateAPIKeyRequest": { "properties": { "description": { "type": "string" }, "expiration_time": { "type": "string" }, "name": { "type": "string" }, "role_id": { "type": "string" } }, "required": [ "expiration_time", "name", "role_id" ], "type": "object" }, "routesV2.CreateBillingAccountRequest": { "properties": { "billing_email": { "description": "Email address for billing", "type": "string" }, "description": { "description": "Description of the billing account", "type": "string" }, "name": { "description": "Name of the billing account", "type": "string" } }, "required": [ "billing_email", "name" ], "type": "object" }, "routesV2.CreateBillingAccountRoleRequest": { "properties": { "description": { "description": "Description of the role", "type": "string" }, "name": { "description": "Name of the role", "type": "string" }, "permissions": { "description": "Permission slugs for the role", "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "name", "permissions" ], "type": "object" }, "routesV2.CreateBillingAccountSubscriptionRequest": { "properties": { "product_id": { "description": "ProductID is the ID of the product to subscribe to", "type": "string" } }, "required": [ "product_id" ], "type": "object" }, "routesV2.CreateBillingAccountSubscriptionResponse": { "properties": { "checkout_url": { "description": "CheckoutURL is a secure URL to add payment information\nand subscribe to the product", "type": "string" } }, "type": "object" }, "routesV2.CreateInputRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.InputConfig" }, "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "routesV2.CreateOrUpdateSecretRequest": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "routesV2.CreateOutputRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.OutputConfig" }, "description": { "type": "string" }, "name": { "type": "string" }, "output_type": { "type": "string" }, "promise_id": { "type": "string" } }, "type": "object" }, "routesV2.CreatePipelineRequest": { "properties": { "description": { "type": "string" }, "edges": { "items": { "$ref": "#/components/schemas/routesV2.PipelineRequestEdge" }, "type": "array", "uniqueItems": false }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "nodes": { "items": { "$ref": "#/components/schemas/routesV2.PipelineRequestNode" }, "type": "array", "uniqueItems": false } }, "required": [ "edges", "enabled", "name", "nodes" ], "type": "object" }, "routesV2.CreateRoleV2Request": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "permission_ids": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "name", "permission_ids" ], "type": "object" }, "routesV2.CreatebillingAccountUserRoleRequest": { "properties": { "user_email": { "description": "Email of the user", "type": "string" } }, "required": [ "user_email" ], "type": "object" }, "routesV2.GenerateRecordRequest": { "properties": { "record_type": { "type": "string" } }, "type": "object" }, "routesV2.GenerateRecordResponse": { "properties": { "record": { "items": { "type": "integer" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV2.ListTemplatesResponse": { "properties": { "templates": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV2.MetricsResponse": { "properties": { "egress_bytes": { "items": { "$ref": "#/components/schemas/routesV2.PipelineMetric" }, "type": "array", "uniqueItems": false }, "ingress_bytes": { "items": { "$ref": "#/components/schemas/routesV2.PipelineMetric" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV2.MetricsValue": { "properties": { "timestamp": { "type": "integer" }, "value": { "type": "number" } }, "type": "object" }, "routesV2.PatchPipelineEdgeRequest": { "properties": { "disabled": { "type": "boolean" } }, "type": "object" }, "routesV2.PipelineMetric": { "properties": { "pipeline_id": { "type": "string" }, "pipeline_name": { "type": "string" }, "total_bytes": { "type": "integer" }, "values": { "items": { "$ref": "#/components/schemas/routesV2.MetricsValue" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV2.PipelineRequestEdge": { "properties": { "conditions": { "$ref": "#/components/schemas/models.ConditionEvaluatable" }, "description": { "type": "string" }, "disabled": { "type": "boolean" }, "from_node_instance_id": { "type": "string" }, "name": { "type": "string" }, "to_node_instance_id": { "type": "string" } }, "required": [ "from_node_instance_id", "to_node_instance_id" ], "type": "object" }, "routesV2.PipelineRequestNode": { "properties": { "component_id": { "type": "string" }, "component_type": { "$ref": "#/components/schemas/models.ComponentType" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "component_id", "component_type", "enabled" ], "type": "object" }, "routesV2.PutInputRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.InputConfig" }, "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "routesV2.PutOutputRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.OutputConfig" }, "description": { "type": "string" }, "name": { "type": "string" }, "output_type": { "type": "string" } }, "type": "object" }, "routesV2.SecretResponse": { "description": "A secret object without sensitive data", "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "routesV2.SetStorageTypeCostEntry": { "properties": { "cost_per_gb": { "type": "number" } }, "type": "object" }, "routesV2.SetStorageTypeCostRequest": { "properties": { "costs": { "additionalProperties": { "$ref": "#/components/schemas/routesV2.SetStorageTypeCostEntry" }, "type": "object" } }, "type": "object" }, "routesV2.StorageTypeDetailsResponse": { "properties": { "end_at": { "type": "string" }, "organization_id": { "type": "string" }, "organization_name": { "type": "string" }, "outputs": { "items": { "$ref": "#/components/schemas/routesV2.StorageTypeOutputDetailResponse" }, "type": "array", "uniqueItems": false }, "start_at": { "type": "string" } }, "type": "object" }, "routesV2.StorageTypeOutputDetailResponse": { "properties": { "egress_bytes": { "type": "integer" }, "egress_gb": { "type": "number" }, "ingress_bytes": { "type": "integer" }, "ingress_gb": { "type": "number" }, "input_id": { "type": "string" }, "output_id": { "type": "string" }, "pipeline_id": { "type": "string" }, "storage_type": { "type": "string" } }, "type": "object" }, "routesV2.SuccessResponse": { "properties": { "message": { "example": "success", "type": "string" } }, "type": "object" }, "routesV2.TestInputConnectionRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.InputConfig" }, "type": { "type": "string" } }, "type": "object" }, "routesV2.TestOutputConnectionRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.OutputConfig" }, "type": { "type": "string" } }, "type": "object" }, "routesV2.UpdateAPIKeyRequest": { "properties": { "description": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "routesV2.UpdateBillingAccountRequest": { "properties": { "billing_email": { "description": "Email address for billing", "type": "string" }, "description": { "description": "Description of the billing account", "type": "string" }, "name": { "description": "Name of the billing account", "type": "string" } }, "type": "object" }, "routesV2.UpdateBillingAccountRoleRequest": { "properties": { "description": { "description": "Description of the role", "type": "string" }, "name": { "description": "Name of the role", "type": "string" }, "permissions": { "description": "Permission slugs for the role", "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV2.UpdateInputRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.InputConfig" }, "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "routesV2.UpdateOutputRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.OutputConfig" }, "description": { "type": "string" }, "name": { "type": "string" }, "output_type": { "type": "string" } }, "type": "object" }, "routesV2.UpdatePipelineRequest": { "properties": { "description": { "type": "string" }, "edges": { "items": { "$ref": "#/components/schemas/routesV2.PipelineRequestEdge" }, "type": "array", "uniqueItems": false }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "nodes": { "items": { "$ref": "#/components/schemas/routesV2.PipelineRequestNode" }, "type": "array", "uniqueItems": false } }, "required": [ "edges", "enabled", "name", "nodes" ], "type": "object" }, "routesV2.UpdateRoleV2Request": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "permission_ids": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV2.getOrganizationSummaryResponse": { "properties": { "organization_id": { "type": "string" }, "pipelines": { "items": { "$ref": "#/components/schemas/routesV2.pipelineStatus" }, "type": "array", "uniqueItems": false }, "summary": { "$ref": "#/components/schemas/routesV2.organizationOverview" } }, "required": [ "organization_id" ], "type": "object" }, "routesV2.organizationOverview": { "properties": { "disabled": { "type": "integer" }, "egress": { "$ref": "#/components/schemas/models.DataUsage" }, "errors": { "type": "integer" }, "expired_messages": { "type": "integer" }, "healthy": { "type": "integer" }, "ingress": { "$ref": "#/components/schemas/models.DataUsage" }, "last_ingested_time": { "type": "string" }, "unhealthy": { "type": "integer" } }, "required": [ "disabled", "healthy", "unhealthy" ], "type": "object" }, "routesV2.pipelineStatus": { "properties": { "egress": { "$ref": "#/components/schemas/models.DataUsage" }, "errors": { "type": "integer" }, "expired_messages": { "type": "integer" }, "ingress": { "$ref": "#/components/schemas/models.DataUsage" }, "last_ingested_time": { "type": "string" }, "pipeline_id": { "type": "string" }, "pipeline_name": { "type": "string" }, "status": { "type": "string" } }, "required": [ "pipeline_id", "pipeline_name", "status" ], "type": "object" }, "routesV2.pipelineWithStatus": { "properties": { "id": { "type": "string" }, "last_ingested_time": { "type": "string" }, "status": { "$ref": "#/components/schemas/models.PipelineStatusValue" } }, "required": [ "id", "status" ], "type": "object" }, "routesV3.AlertList": { "properties": { "alerts": { "items": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Alert" }, "type": "array", "uniqueItems": false }, "total": { "type": "integer" } }, "type": "object" }, "routesV3.CreateAlertRuleRequest": { "properties": { "active": { "description": "Active indicates whether the alert rule is active", "type": "boolean" }, "description": { "description": "Description of the alert rule", "type": "string" }, "name": { "description": "Name of the alert rule", "type": "string" }, "pipeline_ids": { "description": "Pipeline IDs that this alert rule applies to", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "rule_config": { "additionalProperties": {}, "description": "RuleConfig contains the configuration for the alert rule", "type": "object" }, "severity": { "description": "Severity level of the alert (e.g., \"critical\", \"warning\", \"info\")", "type": "string" }, "type": { "description": "Type of the alert rule", "type": "string" } }, "type": "object" }, "routesV3.CreateChildOrganizationRequest": { "properties": { "description": { "type": "string" }, "friendly_name": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "routesV3.CreateConnectionRequest": { "properties": { "description": { "description": "Description of the connection", "type": "string" }, "name": { "description": "Name of the connection", "type": "string" }, "saml": { "description": "SAML is the configuration for SAML connections", "properties": { "entity_id": { "description": "EntityID is the unique identifier for the SAML connection", "type": "string" }, "metadata_url": { "description": "MetadataURL is the URL to IDPs SAML metadata", "type": "string" } }, "type": "object" } }, "type": "object" }, "routesV3.CreateEnrichmentRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.EnrichmentConfig" }, "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "routesV3.EnrichmentSandboxRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.EnrichmentConfig" }, "record": { "items": { "type": "integer" }, "type": "array", "uniqueItems": false }, "type_id": { "type": "string" }, "use_mocked_data": { "type": "boolean" } }, "type": "object" }, "routesV3.EnrichmentSandboxResponse": { "properties": { "record": { "items": { "type": "integer" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV3.FieldUpdation": { "properties": { "change_reason": { "type": "string" }, "field_path": { "type": "string" }, "impact_assessment": { "type": "string" } }, "type": "object" }, "routesV3.GetEnrichmentResponse": { "properties": { "component_of": { "items": { "$ref": "#/components/schemas/models.Pipeline" }, "type": "array", "uniqueItems": false }, "config": { "$ref": "#/components/schemas/models.EnrichmentConfig" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "managed_by": { "$ref": "#/components/schemas/models.ManagedBy" }, "name": { "type": "string" }, "organization_id": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "routesV3.GetFeatureFlagResponse": { "properties": { "organizations": { "additionalProperties": { "items": { "$ref": "#/components/schemas/flagsmith.Flag" }, "type": "array" }, "type": "object" }, "user": { "items": { "$ref": "#/components/schemas/flagsmith.Flag" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV3.ImportTransformResponse": { "properties": { "config": { "$ref": "#/components/schemas/routesV3.TransformConfig" }, "description": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "routesV3.MFAStatusResponse": { "properties": { "enabled": { "type": "boolean" }, "methods": { "items": { "$ref": "#/components/schemas/authenticationtypes.AuthenticationMethod" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV3.PutEnrichmentRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.EnrichmentConfig" }, "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "routesV3.SecurityDataAnalysis": { "properties": { "error_msg": { "type": "string" }, "summary": { "$ref": "#/components/schemas/routesV3.Summary" }, "transform_operations_with_rationale": { "items": { "$ref": "#/components/schemas/routesV3.TransformOperationWithRationale" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV3.SuccessResponse": { "properties": { "message": { "type": "string" } }, "type": "object" }, "routesV3.Summary": { "properties": { "estimated_size_change_percent": { "type": "integer" }, "fields_to_update": { "type": "integer" }, "total_fields": { "type": "integer" } }, "type": "object" }, "routesV3.TestEnrichmentConnectionRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.EnrichmentConfig" }, "type": { "type": "string" } }, "type": "object" }, "routesV3.TransformConfig": { "properties": { "operations": { "items": { "$ref": "#/components/schemas/routesV3.TransformOperation" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV3.TransformOperation": { "properties": { "arguments": { "additionalProperties": {}, "type": "object" }, "operation": { "type": "string" } }, "type": "object" }, "routesV3.TransformOperationWithRationale": { "properties": { "field_updation_rationale": { "$ref": "#/components/schemas/routesV3.FieldUpdation" }, "operation": { "$ref": "#/components/schemas/routes.TransformOperation" } }, "type": "object" }, "routesV3.TransformRecommendationRequest": { "properties": { "optimizer_type": { "type": "string" }, "security_data": { "items": { "type": "integer" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "routesV3.UpdateAlertRuleRequest": { "properties": { "active": { "description": "Active indicates whether the alert rule is active", "type": "boolean" }, "description": { "description": "Description of the alert rule", "type": "string" }, "name": { "description": "Name of the alert rule", "type": "string" }, "pipeline_ids": { "description": "Pipeline IDs that this alert rule applies to", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "rule_config": { "additionalProperties": {}, "description": "RuleConfig contains the configuration for the alert rule", "type": "object" }, "severity": { "description": "Severity level of the alert (e.g., \"critical\", \"warning\", \"info\")", "type": "string" } }, "type": "object" }, "routesV3.UpdateChildOrganizationRequest": { "properties": { "description": { "type": "string" }, "friendly_name": { "type": "string" } }, "required": [ "friendly_name" ], "type": "object" }, "routesV3.UpdateConnectionRequest": { "properties": { "description": { "description": "Connection Description to be updated", "type": "string" }, "name": { "description": "Connection Name to be updated", "type": "string" } }, "type": "object" }, "routesV3.UpdateEnrichmentRequest": { "properties": { "config": { "$ref": "#/components/schemas/secret_processesor.EnrichmentConfig" }, "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "routesV3.optimizerType": { "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "s3.SecretsConfig": { "description": "S3 Output Secrets", "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "s3.SettingsConfig": { "description": "S3 Output Settings", "properties": { "batch_config": { "$ref": "#/components/schemas/batch_config.BatchConfig" }, "bucket": { "description": "The name of the S3 bucket where data will be stored", "type": "string" }, "compression": { "description": "The compression method to be applied to the data before storing in S3", "type": "string" }, "format_config": { "$ref": "#/components/schemas/formatter.FormatConfig" }, "partition_format": { "description": "Directory structure used to partition stored objects. Options: simple date (e.g., '2024/01/01'), hive compliant (e.g., 'year=2024/month=01/day=01'), and flat hive compliant (e.g., 'dt=2024-01-01').", "type": "string" }, "prefix": { "description": "An optional prefix for S3 object keys to organize data within the bucket", "type": "string" }, "region": { "description": "The AWS region where the S3 bucket is located", "type": "string" }, "role_arn": { "description": "The Amazon Resource Name (ARN) of the IAM role to assume which grants access to the S3 bucket", "type": "string" } }, "type": "object" }, "secret_processesor.EnrichmentConfig": { "properties": { "secrets": { "additionalProperties": {}, "oneOf": [ { "$ref": "#/components/schemas/community_edition.SecretsConfig" }, { "$ref": "#/components/schemas/geolocus.SecretsConfig" }, { "$ref": "#/components/schemas/kv_lookup.SecretsConfig" }, { "$ref": "#/components/schemas/models.RawConfig" } ], "type": "object" }, "settings": { "additionalProperties": {}, "oneOf": [ { "$ref": "#/components/schemas/community_edition.SettingsConfig" }, { "$ref": "#/components/schemas/geolocus.SettingsConfig" }, { "$ref": "#/components/schemas/kv_lookup.SettingsConfig" }, { "$ref": "#/components/schemas/models.RawConfig" } ], "type": "object" } }, "type": "object" }, "secret_processesor.InputConfig": { "properties": { "secrets": { "additionalProperties": {}, "oneOf": [ { "$ref": "#/components/schemas/admin_logs.SecretsConfig" }, { "$ref": "#/components/schemas/aiven_service_logs.SecretsConfig" }, { "$ref": "#/components/schemas/arize_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/auth_logs.SecretsConfig" }, { "$ref": "#/components/schemas/aws_guardduty.SecretsConfig" }, { "$ref": "#/components/schemas/aws_s3.SecretsConfig" }, { "$ref": "#/components/schemas/azure_activity_logs.SecretsConfig" }, { "$ref": "#/components/schemas/azure_blob_storage.SecretsConfig" }, { "$ref": "#/components/schemas/azure_event_hubs.SecretsConfig" }, { "$ref": "#/components/schemas/azure_vnet_flow_logs.SecretsConfig" }, { "$ref": "#/components/schemas/backblaze_b2.SecretsConfig" }, { "$ref": "#/components/schemas/bigquery_input.SecretsConfig" }, { "$ref": "#/components/schemas/bitwarden_events.SecretsConfig" }, { "$ref": "#/components/schemas/box_events.SecretsConfig" }, { "$ref": "#/components/schemas/brinqa_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/bugsnag_org_events.SecretsConfig" }, { "$ref": "#/components/schemas/buildkite_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/buildkite_graphql_input.SecretsConfig" }, { "$ref": "#/components/schemas/cisa_user.SecretsConfig" }, { "$ref": "#/components/schemas/cloud_configuration_findings.SecretsConfig" }, { "$ref": "#/components/schemas/cloud_logs.SecretsConfig" }, { "$ref": "#/components/schemas/cloud_resource_inventory.SecretsConfig" }, { "$ref": "#/components/schemas/cloud_resource_inventory_reports.SecretsConfig" }, { "$ref": "#/components/schemas/cloudflare_ddos_attack_analytics.SecretsConfig" }, { "$ref": "#/components/schemas/cloudflare_firewall_events.SecretsConfig" }, { "$ref": "#/components/schemas/cloudflare_http_requests.SecretsConfig" }, { "$ref": "#/components/schemas/cloudflare_url_scanner.SecretsConfig" }, { "$ref": "#/components/schemas/cloudflare_zero_trust_access_requests.SecretsConfig" }, { "$ref": "#/components/schemas/clumio_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/clumio_consolidated_alerts.SecretsConfig" }, { "$ref": "#/components/schemas/coda_audit_events.SecretsConfig" }, { "$ref": "#/components/schemas/cortex_xsoar_management_logs.SecretsConfig" }, { "$ref": "#/components/schemas/customer_event_data.SecretsConfig" }, { "$ref": "#/components/schemas/defender_for_endpoint_alerts.SecretsConfig" }, { "$ref": "#/components/schemas/duo_security_activity_logs.SecretsConfig" }, { "$ref": "#/components/schemas/eks_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/endor_labs_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/entra_id.SecretsConfig" }, { "$ref": "#/components/schemas/event.SecretsConfig" }, { "$ref": "#/components/schemas/full_scans.SecretsConfig" }, { "$ref": "#/components/schemas/gitlab_issues.SecretsConfig" }, { "$ref": "#/components/schemas/gke_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/google_cloud_storage.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/google_workspace.SecretsConfig" }, { "$ref": "#/components/schemas/greenhouse_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/individual_alerts.SecretsConfig" }, { "$ref": "#/components/schemas/inspector.SecretsConfig" }, { "$ref": "#/components/schemas/issues.SecretsConfig" }, { "$ref": "#/components/schemas/issues_report.SecretsConfig" }, { "$ref": "#/components/schemas/koi_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/log_analytics_query.SecretsConfig" }, { "$ref": "#/components/schemas/meraki_config_logs.SecretsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SecretsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SecretsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SecretsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SecretsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SecretsConfig" }, { "$ref": "#/components/schemas/models.RawConfig" }, { "$ref": "#/components/schemas/monad_log.SecretsConfig" }, { "$ref": "#/components/schemas/object_storage_input.SecretsConfig" }, { "$ref": "#/components/schemas/offlineenrollmentlogs.SecretsConfig" }, { "$ref": "#/components/schemas/onelogin_events.SecretsConfig" }, { "$ref": "#/components/schemas/opal_events.SecretsConfig" }, { "$ref": "#/components/schemas/operation_logs.SecretsConfig" }, { "$ref": "#/components/schemas/org_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/ownbackup_account_events.SecretsConfig" }, { "$ref": "#/components/schemas/pagerduty_audit_records.SecretsConfig" }, { "$ref": "#/components/schemas/palo_alto_data_security_alerts.SecretsConfig" }, { "$ref": "#/components/schemas/polymer.SecretsConfig" }, { "$ref": "#/components/schemas/postman_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/pubsub.SecretsConfig" }, { "$ref": "#/components/schemas/rootly_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/semgrep_code_findings.SecretsConfig" }, { "$ref": "#/components/schemas/semgrep_supply_chain_findings.SecretsConfig" }, { "$ref": "#/components/schemas/sentry_org_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/slack_enterprise_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/snowflake_input.SecretsConfig" }, { "$ref": "#/components/schemas/snyk_issues.SecretsConfig" }, { "$ref": "#/components/schemas/snyk_targets.SecretsConfig" }, { "$ref": "#/components/schemas/synthetic_data.SecretsConfig" }, { "$ref": "#/components/schemas/synthetic_data_custom.SecretsConfig" }, { "$ref": "#/components/schemas/tanium_graphql_input.SecretsConfig" }, { "$ref": "#/components/schemas/team_access_logs.SecretsConfig" }, { "$ref": "#/components/schemas/team_integration_logs.SecretsConfig" }, { "$ref": "#/components/schemas/telephony_logs.SecretsConfig" }, { "$ref": "#/components/schemas/tenable_assets.SecretsConfig" }, { "$ref": "#/components/schemas/tenable_assets_cron.SecretsConfig" }, { "$ref": "#/components/schemas/tenable_vulnerabilities.SecretsConfig" }, { "$ref": "#/components/schemas/tenable_vulnerabilities_cron.SecretsConfig" }, { "$ref": "#/components/schemas/tines_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/tines_events_logs.SecretsConfig" }, { "$ref": "#/components/schemas/twilio_events.SecretsConfig" }, { "$ref": "#/components/schemas/twilio_sendgrid_email_activity.SecretsConfig" }, { "$ref": "#/components/schemas/universal.SecretsConfig" }, { "$ref": "#/components/schemas/vercel_user_events.SecretsConfig" }, { "$ref": "#/components/schemas/voltio_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/vulnerability_findings.SecretsConfig" }, { "$ref": "#/components/schemas/vulnerability_findings_report.SecretsConfig" }, { "$ref": "#/components/schemas/wiz_audit_logs.SecretsConfig" }, { "$ref": "#/components/schemas/zendesk_audit_logs.SecretsConfig" } ], "type": "object" }, "settings": { "additionalProperties": {}, "oneOf": [ { "$ref": "#/components/schemas/admin_logs.SettingsConfig" }, { "$ref": "#/components/schemas/aiven_service_logs.SettingsConfig" }, { "$ref": "#/components/schemas/arize_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/auth_logs.SettingsConfig" }, { "$ref": "#/components/schemas/aws_guardduty.SettingsConfig" }, { "$ref": "#/components/schemas/aws_s3.SettingsConfig" }, { "$ref": "#/components/schemas/awssqss3.SettingsConfig" }, { "$ref": "#/components/schemas/azure_activity_logs.SettingsConfig" }, { "$ref": "#/components/schemas/azure_blob_storage.SettingsConfig" }, { "$ref": "#/components/schemas/azure_event_hubs.SettingsConfig" }, { "$ref": "#/components/schemas/azure_vnet_flow_logs.SettingsConfig" }, { "$ref": "#/components/schemas/backblaze_b2.SettingsConfig" }, { "$ref": "#/components/schemas/bigquery_input.SettingsConfig" }, { "$ref": "#/components/schemas/bitwarden_events.SettingsConfig" }, { "$ref": "#/components/schemas/box_events.SettingsConfig" }, { "$ref": "#/components/schemas/brinqa_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/bugsnag_org_events.SettingsConfig" }, { "$ref": "#/components/schemas/buildkite_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/buildkite_graphql_input.SettingsConfig" }, { "$ref": "#/components/schemas/cisa_user.SettingsConfig" }, { "$ref": "#/components/schemas/cloud_configuration_findings.SettingsConfig" }, { "$ref": "#/components/schemas/cloud_logs.SettingsConfig" }, { "$ref": "#/components/schemas/cloud_resource_inventory.SettingsConfig" }, { "$ref": "#/components/schemas/cloud_resource_inventory_reports.SettingsConfig" }, { "$ref": "#/components/schemas/cloudflare_ddos_attack_analytics.SettingsConfig" }, { "$ref": "#/components/schemas/cloudflare_firewall_events.SettingsConfig" }, { "$ref": "#/components/schemas/cloudflare_http_requests.SettingsConfig" }, { "$ref": "#/components/schemas/cloudflare_url_scanner.SettingsConfig" }, { "$ref": "#/components/schemas/cloudflare_zero_trust_access_requests.SettingsConfig" }, { "$ref": "#/components/schemas/cloudtrail.SettingsConfig" }, { "$ref": "#/components/schemas/clumio_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/clumio_consolidated_alerts.SettingsConfig" }, { "$ref": "#/components/schemas/coda_audit_events.SettingsConfig" }, { "$ref": "#/components/schemas/cortex_xsoar_management_logs.SettingsConfig" }, { "$ref": "#/components/schemas/customer_event_data.SettingsConfig" }, { "$ref": "#/components/schemas/defender_for_endpoint_alerts.SettingsConfig" }, { "$ref": "#/components/schemas/duo_security_activity_logs.SettingsConfig" }, { "$ref": "#/components/schemas/eks_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/endor_labs_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/entra_id.SettingsConfig" }, { "$ref": "#/components/schemas/event.SettingsConfig" }, { "$ref": "#/components/schemas/full_scans.SettingsConfig" }, { "$ref": "#/components/schemas/gitlab_issues.SettingsConfig" }, { "$ref": "#/components/schemas/gke_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/google_cloud_storage.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/google_workspace.SettingsConfig" }, { "$ref": "#/components/schemas/greenhouse_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/individual_alerts.SettingsConfig" }, { "$ref": "#/components/schemas/inspector.SettingsConfig" }, { "$ref": "#/components/schemas/issues.SettingsConfig" }, { "$ref": "#/components/schemas/issues_report.SettingsConfig" }, { "$ref": "#/components/schemas/koi_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/log_analytics_query.SettingsConfig" }, { "$ref": "#/components/schemas/meraki_config_logs.SettingsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SettingsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SettingsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SettingsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SettingsConfig" }, { "$ref": "#/components/schemas/microsoft_365_generic.SettingsConfig" }, { "$ref": "#/components/schemas/models.RawConfig" }, { "$ref": "#/components/schemas/monad_log.SettingsConfig" }, { "$ref": "#/components/schemas/object_storage_input.SettingsConfig" }, { "$ref": "#/components/schemas/offlineenrollmentlogs.SettingsConfig" }, { "$ref": "#/components/schemas/onelogin_events.SettingsConfig" }, { "$ref": "#/components/schemas/opal_events.SettingsConfig" }, { "$ref": "#/components/schemas/openai_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/operation_logs.SettingsConfig" }, { "$ref": "#/components/schemas/oracle.SettingsConfig" }, { "$ref": "#/components/schemas/org_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/ownbackup_account_events.SettingsConfig" }, { "$ref": "#/components/schemas/pagerduty_audit_records.SettingsConfig" }, { "$ref": "#/components/schemas/palo_alto_data_security_alerts.SettingsConfig" }, { "$ref": "#/components/schemas/polymer.SettingsConfig" }, { "$ref": "#/components/schemas/postman_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/pubsub.SettingsConfig" }, { "$ref": "#/components/schemas/rootly_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/semgrep_code_findings.SettingsConfig" }, { "$ref": "#/components/schemas/semgrep_supply_chain_findings.SettingsConfig" }, { "$ref": "#/components/schemas/sentry_org_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/slack_enterprise_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/snowflake_input.SettingsConfig" }, { "$ref": "#/components/schemas/snyk_issues.SettingsConfig" }, { "$ref": "#/components/schemas/snyk_targets.SettingsConfig" }, { "$ref": "#/components/schemas/synthetic_data.SettingsConfig" }, { "$ref": "#/components/schemas/synthetic_data_custom.SettingsConfig" }, { "$ref": "#/components/schemas/tanium_graphql_input.SettingsConfig" }, { "$ref": "#/components/schemas/team_access_logs.SettingsConfig" }, { "$ref": "#/components/schemas/team_integration_logs.SettingsConfig" }, { "$ref": "#/components/schemas/telephony_logs.SettingsConfig" }, { "$ref": "#/components/schemas/tenable_assets.SettingsConfig" }, { "$ref": "#/components/schemas/tenable_assets_cron.SettingsConfig" }, { "$ref": "#/components/schemas/tenable_vulnerabilities.SettingsConfig" }, { "$ref": "#/components/schemas/tenable_vulnerabilities_cron.SettingsConfig" }, { "$ref": "#/components/schemas/tines_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/tines_events_logs.SettingsConfig" }, { "$ref": "#/components/schemas/twilio_events.SettingsConfig" }, { "$ref": "#/components/schemas/twilio_sendgrid_email_activity.SettingsConfig" }, { "$ref": "#/components/schemas/universal.SettingsConfig" }, { "$ref": "#/components/schemas/vercel_user_events.SettingsConfig" }, { "$ref": "#/components/schemas/voltio_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/vulnerability_findings.SettingsConfig" }, { "$ref": "#/components/schemas/vulnerability_findings_report.SettingsConfig" }, { "$ref": "#/components/schemas/wiz_audit_logs.SettingsConfig" }, { "$ref": "#/components/schemas/zendesk_audit_logs.SettingsConfig" } ], "type": "object" } }, "type": "object" }, "secret_processesor.OutputConfig": { "properties": { "secrets": { "additionalProperties": {}, "oneOf": [ { "$ref": "#/components/schemas/abs.SecretsConfig" }, { "$ref": "#/components/schemas/axiom.SecretsConfig" }, { "$ref": "#/components/schemas/backblaze.SecretsConfig" }, { "$ref": "#/components/schemas/bigquery.SecretsConfig" }, { "$ref": "#/components/schemas/cribl_http.SecretsConfig" }, { "$ref": "#/components/schemas/databricks.SecretsConfig" }, { "$ref": "#/components/schemas/datadog.SecretsConfig" }, { "$ref": "#/components/schemas/elasticsearch.SecretsConfig" }, { "$ref": "#/components/schemas/google_cloud_storage_output.SecretsConfig" }, { "$ref": "#/components/schemas/http.SecretsConfig" }, { "$ref": "#/components/schemas/kafka.SecretsConfig" }, { "$ref": "#/components/schemas/kv_lookup_output.SecretsConfig" }, { "$ref": "#/components/schemas/models.RawConfig" }, { "$ref": "#/components/schemas/next_gen_siem.SecretsConfig" }, { "$ref": "#/components/schemas/object_storage.SecretsConfig" }, { "$ref": "#/components/schemas/opensearch.SecretsConfig" }, { "$ref": "#/components/schemas/pagerduty.SecretsConfig" }, { "$ref": "#/components/schemas/panther.SecretsConfig" }, { "$ref": "#/components/schemas/postgresql.SecretsConfig" }, { "$ref": "#/components/schemas/s3.SecretsConfig" }, { "$ref": "#/components/schemas/sentinel.SecretsConfig" }, { "$ref": "#/components/schemas/snowflake_output.SecretsConfig" }, { "$ref": "#/components/schemas/splunk.SecretsConfig" }, { "$ref": "#/components/schemas/sumologic.SecretsConfig" } ], "type": "object" }, "settings": { "additionalProperties": {}, "oneOf": [ { "$ref": "#/components/schemas/abs.SettingsConfig" }, { "$ref": "#/components/schemas/awssqsoutput.SettingsConfig" }, { "$ref": "#/components/schemas/axiom.SettingsConfig" }, { "$ref": "#/components/schemas/backblaze.SettingsConfig" }, { "$ref": "#/components/schemas/bigquery.SettingsConfig" }, { "$ref": "#/components/schemas/cribl_http.SettingsConfig" }, { "$ref": "#/components/schemas/databricks.SettingsConfig" }, { "$ref": "#/components/schemas/datadog.SettingsConfig" }, { "$ref": "#/components/schemas/elasticsearch.SettingsConfig" }, { "$ref": "#/components/schemas/google_cloud_storage_output.SettingsConfig" }, { "$ref": "#/components/schemas/http.SettingsConfig" }, { "$ref": "#/components/schemas/kafka.SettingsConfig" }, { "$ref": "#/components/schemas/kv_lookup_output.SettingsConfig" }, { "$ref": "#/components/schemas/models.RawConfig" }, { "$ref": "#/components/schemas/next_gen_siem.SettingsConfig" }, { "$ref": "#/components/schemas/object_storage.SettingsConfig" }, { "$ref": "#/components/schemas/opensearch.SettingsConfig" }, { "$ref": "#/components/schemas/pagerduty.SettingsConfig" }, { "$ref": "#/components/schemas/panther.SettingsConfig" }, { "$ref": "#/components/schemas/postgresql.SettingsConfig" }, { "$ref": "#/components/schemas/prometheus.SettingsConfig" }, { "$ref": "#/components/schemas/s3.SettingsConfig" }, { "$ref": "#/components/schemas/security_lake.SettingsConfig" }, { "$ref": "#/components/schemas/sentinel.SettingsConfig" }, { "$ref": "#/components/schemas/slack.SettingsConfig" }, { "$ref": "#/components/schemas/snowflake_output.SettingsConfig" }, { "$ref": "#/components/schemas/splunk.SettingsConfig" }, { "$ref": "#/components/schemas/sumologic.SettingsConfig" } ], "type": "object" } }, "type": "object" }, "security_lake.SettingsConfig": { "description": "Security Lake Output Settings", "properties": { "batch_config": { "$ref": "#/components/schemas/batch_config.BatchConfig" }, "bucketName": { "description": "Bucket Name", "type": "string" }, "bucket_url": { "description": "The name of the S3 bucket where data will be stored", "type": "string" }, "key": { "description": "S3 Key", "type": "string" }, "parquet_format": { "$ref": "#/components/schemas/parquet.ParquetFormatter" }, "role_arn": { "description": "The Amazon Resource Name (ARN) of the IAM role to assume which grants access to the S3 bucket", "type": "string" }, "source_account_details": { "$ref": "#/components/schemas/security_lake.SourceAccountDetails" } }, "type": "object" }, "security_lake.SourceAccountDetails": { "description": "Details about the source AWS account and region for Security Lake", "properties": { "source_account_id": { "description": "Source AWS Account ID", "type": "string" }, "source_region": { "description": "Source AWS Region", "type": "string" } }, "type": "object" }, "semgrep_code_findings.SecretsConfig": { "description": "Semgrep code findings secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "semgrep_code_findings.SettingsConfig": { "description": "Semgrep code findings settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "semgrep_supply_chain_findings.SecretsConfig": { "description": "Semgrep supply chain findings secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "semgrep_supply_chain_findings.SettingsConfig": { "description": "Semgrep supply chain findings settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "sentinel.SecretsConfig": { "description": "Sentinel Output Secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" }, "tenant_id": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "sentinel.SettingsConfig": { "description": "Sentinel Output Settings", "properties": { "endpoint": { "description": "The Azure Monitor Data Collection Rule (DCR) ingestion endpoint URL.", "type": "string" }, "rule_id": { "description": "The unique identifier of the Data Collection Rule (DCR).", "type": "string" }, "stream_name": { "description": "The name of the data stream defined in the Data Collection Rule.", "type": "string" } }, "type": "object" }, "sentry_org_audit_logs.SecretsConfig": { "description": "Sentry Organization Audit Logs secrets", "properties": { "auth_token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "auth_token" ], "type": "object" }, "sentry_org_audit_logs.SettingsConfig": { "description": "Sentry Organization Audit Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "host_name": { "description": "For self-hosted, specify your host name here. Otherwise, leave it default as sentry.io.", "type": "string" }, "org_slug": { "description": "The ID or slug of the organization", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "host_name", "org_slug" ], "type": "object" }, "slack.AuthConfig": { "properties": { "bot_token": { "$ref": "#/components/schemas/slack.BotTokenVariant" }, "type": { "type": "string" }, "webhook": { "$ref": "#/components/schemas/slack.WebhookVariant" } }, "type": "object" }, "slack.BotTokenVariant": { "properties": { "bot_token": { "$ref": "#/components/schemas/models.Secret" }, "channel_id": { "type": "string" } }, "type": "object" }, "slack.SettingsConfig": { "description": "Slack Output Settings", "properties": { "auth_config": { "$ref": "#/components/schemas/slack.AuthConfig" }, "message_template": { "type": "string" } }, "type": "object" }, "slack.WebhookVariant": { "properties": { "webhook_url": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "slack_enterprise_audit_logs.SecretsConfig": { "properties": { "user_oauth_token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "user_oauth_token" ], "type": "object" }, "slack_enterprise_audit_logs.SettingsConfig": { "properties": { "backfill_start_time": { "description": "Date to start fetching data from. Dates before March 2018 are valid but will result in an error during validation.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "snowflake_input.SecretsConfig": { "description": "Snowflake Input Secrets", "properties": { "password": { "$ref": "#/components/schemas/models.Secret" }, "private_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "snowflake_input.SettingsConfig": { "description": "Snowflake Input Settings", "properties": { "account": { "description": "The unique identifier for your Snowflake account, typically in the form of 'organization-account_name'.", "type": "string" }, "auth_type": { "description": "Authentication type: \"password\" or \"private key\"", "enum": [ "password", "private key" ], "type": "string" }, "cron": { "description": "Cron string for scheduling the ingest of your input", "type": "string" }, "database": { "description": "The name of the Snowflake database to connect to and perform operations on", "type": "string" }, "query": { "description": "Optional custom query to use instead of table (must include timestamp_column)", "type": "string" }, "role": { "description": "The name of the Role your service account was granted which can access your resources.", "type": "string" }, "schema": { "description": "The schema within the Snowflake database where the target table resides.", "type": "string" }, "table": { "description": "The name of the table in Snowflake to query data from.", "type": "string" }, "timestamp_column": { "description": "The column containing timestamp values used for incremental loading", "type": "string" }, "user": { "description": "The username of the Snowflake account used to establish the connection.", "type": "string" }, "warehouse": { "description": "The Snowflake virtual warehouse to use for executing queries and processing data.", "type": "string" } }, "required": [ "account", "auth_type", "cron", "database", "role", "schema", "timestamp_column", "user", "warehouse" ], "type": "object" }, "snowflake_output.SecretsConfig": { "description": "Snowflake Output Secrets", "properties": { "password": { "$ref": "#/components/schemas/models.Secret" }, "private_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "snowflake_output.SettingsConfig": { "description": "Snowflake Output Settings", "properties": { "account": { "description": "The unique identifier for your Snowflake account, typically in the form of 'organization-account_name'.", "type": "string" }, "auth_type": { "type": "string" }, "batch_config": { "$ref": "#/components/schemas/batch_config.BatchConfig" }, "case_insensitivity": { "description": "Treat column names as case-insensitive (convert to uppercase) to match Snowflake's default behavior.", "type": "boolean" }, "database": { "description": "The name of the Snowflake database to connect to and perform operations on", "type": "string" }, "role": { "description": "The name of the Role your service account was granted which can access your resources.", "type": "string" }, "schema": { "description": "The schema within the Snowflake database where the target table resides.", "type": "string" }, "stage": { "description": "The name of the Snowflake stage where the data will be copied to. Monad create or replace the stage.", "type": "string" }, "table": { "description": "The name of the table in Snowflake where the data will be written. If the table doesn't exist Monad will create the table.", "type": "string" }, "user": { "description": "The username of the Snowflake account used to establish the connection.", "type": "string" }, "warehouse": { "description": "The Snowflake virtual warehouse to use for executing queries and processing data.", "type": "string" } }, "type": "object" }, "snyk_issues.SecretsConfig": { "description": "Snyk issues secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "snyk_issues.SettingsConfig": { "description": "Snyk issues settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "snyk_targets.SecretsConfig": { "description": "Snyk targets secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "snyk_targets.SettingsConfig": { "description": "Snyk targets settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "splunk.SecretsConfig": { "description": "Splunk Output Secrets", "properties": { "password": { "$ref": "#/components/schemas/models.Secret" }, "token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "splunk.SettingsConfig": { "description": "Splunk Output Settings", "properties": { "allow_insecure": { "description": "Whether to allow insecure connections (not recommended for production).", "type": "boolean" }, "index": { "description": "The index you want to send data to. If left empty, data is sent to the default index associated with the token. If specified, please read our docs for more context on Splunk token \u0026 Index scoping.", "type": "string" }, "port": { "description": "The port of the Splunk instance.", "type": "string" }, "to_create": { "description": "Ensure this is selected if you want Monad to create the index for you. If you are using a pre-existing index, please leave this deselected. Read our docs for more context on Splunk token \u0026 Index scoping.", "type": "boolean" }, "url": { "description": "The URL of the Splunk instance (must start with http or https).", "type": "string" }, "username": { "description": "Represents an administrative account to manage indices. Used to create an index, hence can be left empty if default index is to be used.", "type": "string" } }, "type": "object" }, "sumologic.SecretsConfig": { "description": "Sumo Logic Output Secrets", "properties": { "access_id": { "$ref": "#/components/schemas/models.Secret" }, "access_key": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "sumologic.SettingsConfig": { "description": "Sumo Logic Output Settings", "properties": { "source_metadata": { "$ref": "#/components/schemas/sumologic.SourceMetadata" }, "url": { "description": "The URL of the Sumo Logic instance.", "type": "string" } }, "type": "object" }, "sumologic.SourceMetadata": { "description": "Additional metadata to send with each source.", "properties": { "custom_source_category": { "description": "Desired source category. Useful if you want to override the source category configured for the source.", "type": "string" }, "custom_source_host": { "description": "Desired source host. Useful if you want to override the source host configured for the source.", "type": "string" }, "custom_source_name": { "description": "Desired source name. Useful if you want to override the source name configured for the source.", "type": "string" }, "sumo_fields": { "items": { "$ref": "#/components/schemas/sumologic.SumoField" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "sumologic.SumoField": { "properties": { "field_name": { "description": "Name of the field to reference.", "type": "string" }, "field_value": { "description": "Value of the field to reference.", "type": "string" } }, "type": "object" }, "synthetic_data.SecretsConfig": { "description": "Demo secrets", "type": "object" }, "synthetic_data.SettingsConfig": { "description": "Demo settings", "properties": { "rate": { "description": "The rate at which to generate records (between 1 and 1000) per second", "type": "integer" }, "record_type": { "description": "The type of record to generate", "type": "string" } }, "type": "object" }, "synthetic_data_custom.SecretsConfig": { "description": "Demo Custom secrets", "type": "object" }, "synthetic_data_custom.SettingsConfig": { "description": "Demo Custom settings", "properties": { "custom_template": { "description": "A custom template using the functions we provide to generate demo data", "type": "string" }, "rate": { "description": "The rate at which to generate records (between 1 and 1000) per second", "type": "integer" } }, "type": "object" }, "tanium_graphql_input.SecretsConfig": { "properties": { "api_token": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "tanium_graphql_input.SettingsConfig": { "properties": { "base_url": { "description": "The base URL of your GraphQL endpoint including the path", "type": "string" }, "enable_pagination": { "description": "Enable pagination support", "type": "boolean" }, "graphql_query": { "description": "The GraphQL query to execute against the endpoint to fetch data", "type": "string" }, "has_next_page_path": { "description": "JSONPath location to check if there are more pages", "type": "string" }, "interval_seconds": { "description": "Time interval in seconds between consecutive GraphQL API calls", "type": "integer" }, "pagination_cursor_path": { "description": "JSONPath location for pagination cursor/token", "type": "string" }, "record_location": { "description": "JSONPath location of the records array in the GraphQL response", "type": "string" }, "variables": { "description": "GraphQL query variables to pass with each request", "items": { "$ref": "#/components/schemas/monad_graphql_input.Variable" }, "type": "array", "uniqueItems": false } }, "type": "object" }, "team_access_logs.SecretsConfig": { "description": "Slack Team Access Logs secrets", "properties": { "token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "token" ], "type": "object" }, "team_access_logs.SettingsConfig": { "description": "Slack Team Access Logs settings", "properties": { "backfill_start_time": { "description": "Start time for backfilling data", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "team_integration_logs.SecretsConfig": { "description": "Slack Team Integration Logs secrets", "properties": { "token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "token" ], "type": "object" }, "team_integration_logs.SettingsConfig": { "description": "Slack Team Integration Logs settings", "properties": { "backfill_start_time": { "description": "Start time for backfilling data", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "telephony_logs.SecretsConfig": { "description": "Duo Security Telephony Logs secrets", "properties": { "integration_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "integration_key", "secret_key" ], "type": "object" }, "telephony_logs.SettingsConfig": { "description": "Duo Security Telephony Logs settings", "properties": { "host": { "description": "The API hostname for your Duo Security integration.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "host" ], "type": "object" }, "tenable_assets.SecretsConfig": { "description": "Tenable assets secrets", "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "access_key", "secret_key" ], "type": "object" }, "tenable_assets.SettingsConfig": { "description": "Tenable assets settings", "properties": { "backfill_start_time": { "description": "Date to start fetching assets from. If not specified, a full sync of assets is fetched on the first sync. All syncs thereafter will have incremental data.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "tenable_assets_cron.SecretsConfig": { "description": "Tenable assets secrets", "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "access_key", "secret_key" ], "type": "object" }, "tenable_assets_cron.SettingsConfig": { "description": "Tenable assets settings", "properties": { "cron": { "description": "Cron expression to schedule the data collection.", "type": "string" } }, "type": "object" }, "tenable_vulnerabilities.SecretsConfig": { "description": "Tenable vulnerabilities secrets", "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "access_key", "secret_key" ], "type": "object" }, "tenable_vulnerabilities.SettingsConfig": { "description": "Tenable vulnerabilities settings", "properties": { "backfill_start_time": { "description": "Date to start fetching vulnerabilities from. If not specified, a full sync of assets is fetched on the first sync. All syncs thereafter will have incremental data.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "tenable_vulnerabilities_cron.SecretsConfig": { "description": "Tenable vulnerabilities secrets", "properties": { "access_key": { "$ref": "#/components/schemas/models.Secret" }, "secret_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "access_key", "secret_key" ], "type": "object" }, "tenable_vulnerabilities_cron.SettingsConfig": { "description": "Tenable vulnerabilities settings", "properties": { "cron": { "description": "Cron expression to schedule the data collection.", "type": "string" } }, "type": "object" }, "tines_audit_logs.SecretsConfig": { "description": "Tines Audit Logs secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "tines_audit_logs.SettingsConfig": { "description": "Tines Audit Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, will fetch from the most recent data available.", "type": "string" }, "operation_names": { "description": "Filter by specific operation names (optional)", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "tenant_domain": { "description": "The Tines tenant domain (e.g., your-org.tines.com)", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "user_ids": { "description": "Filter by specific user IDs (optional)", "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "tenant_domain" ], "type": "object" }, "tines_events_logs.SecretsConfig": { "description": "Tines Events Logs secrets", "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "tines_events_logs.SettingsConfig": { "description": "Tines Events Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "story_id": { "description": "Filter by the given story.", "type": "string" }, "team_id": { "description": "Filter by the given team.", "type": "string" }, "tenant_url": { "description": "Unique URL for your Tines instance", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "tenant_url" ], "type": "object" }, "twilio_events.SecretsConfig": { "description": "Twilio Events secrets", "properties": { "twilio_account_sid": { "$ref": "#/components/schemas/models.Secret" }, "twilio_auth_token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "twilio_account_sid", "twilio_auth_token" ], "type": "object" }, "twilio_events.SettingsConfig": { "description": "Twilio Events settings", "properties": { "actor_sid": { "description": "Only includes events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials.", "type": "string" }, "event_type": { "description": "Only includes events of a specific event type: https://www.twilio.com/docs/usage/monitor-events#event-types", "type": "string" }, "replication_start_time": { "description": "Only include events after this time for the initial sync. If not specified, returns all events from the start. Must be a valid ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z'", "type": "string" }, "resource_sid": { "description": "Only include events that refer to this resource. Useful for discovering the history of a specific resource.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "twilio_sendgrid_email_activity.SecretsConfig": { "properties": { "api_key": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "api_key" ], "type": "object" }, "twilio_sendgrid_email_activity.SettingsConfig": { "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "types.StringComparison": { "description": "The operator to use when comparing values in the filter.\n\nThis member is required.", "enum": [ "EQUALS", "PREFIX", "NOT_EQUALS" ], "type": "string", "x-enum-varnames": [ "StringComparisonEquals", "StringComparisonPrefix", "StringComparisonNotEquals" ] }, "types.StringFilter": { "properties": { "comparison": { "$ref": "#/components/schemas/types.StringComparison" }, "value": { "description": "The value to filter on.\n\nThis member is required.", "type": "string" } }, "type": "object" }, "universal.SecretsConfig": { "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" }, "password": { "$ref": "#/components/schemas/models.Secret" }, "username": { "$ref": "#/components/schemas/models.Secret" } }, "type": "object" }, "universal.SettingsConfig": { "properties": { "instance_name": { "description": "Name of the ServiceNow instance", "type": "string" }, "streams": { "description": "ServiceNow streams to fetch data from", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "type": "object" }, "utc_timestamp.ArgumentsConfig": { "properties": { "format": { "$ref": "#/components/schemas/utc_timestamp.TimestampFormat" }, "key": { "description": "The key to store the timestamp in", "type": "string" } }, "type": "object" }, "utc_timestamp.TimestampFormat": { "description": "The format of the timestamp", "enum": [ "rfc3339", "unix", "unix_milli", "unix_nano", "iso8601" ], "type": "string", "x-enum-varnames": [ "RFC3339", "Unix", "UnixMilli", "UnixNano", "ISO8601" ] }, "vercel_user_events.SecretsConfig": { "properties": { "access_token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "access_token" ], "type": "object" }, "vercel_user_events.SettingsConfig": { "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, a full sync of is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic data for testing, instead of connecting to a real data source. Defaults to an hourly cron schedule for cron-based inputs.", "type": "boolean" }, "with_payload": { "description": "Whether to include detailed payload information in the events.", "type": "boolean" } }, "type": "object" }, "voltio_audit_logs.SecretsConfig": { "description": "Volt.io Audit Logs secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" }, "password": { "$ref": "#/components/schemas/models.Secret" }, "username": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret", "password", "username" ], "type": "object" }, "voltio_audit_logs.SettingsConfig": { "description": "Volt.io Audit Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from. If not specified, defaults to 90 days ago. All syncs thereafter will be incremental.", "type": "string" }, "base_url": { "description": "Base URL of your Volt.io API instance (e.g., https://api.volt.io)", "type": "string" }, "customer_id": { "description": "Optional: Filter audit logs by specific customer ID", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "base_url" ], "type": "object" }, "vulnerability_findings.SecretsConfig": { "description": "Wiz vulnerability findings secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" }, "token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "vulnerability_findings.SettingsConfig": { "description": "Wiz vulnerability findings settings", "properties": { "asset_status": { "description": "Asset status types for Wiz. Ex: 'ACTIVE', 'INACTIVE'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "asset_types": { "description": "Asset types for Wiz. Ex: 'VIRTUAL_MACHINE', 'CONTAINER', etc.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": false }, "backfill_start_time": { "description": "Date to start fetching data from. If not specified, Data is fetched since one year ago. All syncs thereafter will be of incremental data.", "type": "string" }, "detection_method": { "description": "Detection method types for Wiz. Ex: 'AGENT', 'CLOUD', 'AGENT_CLOUD'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "endpoint_url": { "description": "Endpoint URL for the Wiz API. Ex: 'https://api.wiz.io/v1/vulnerability-findings'.", "type": "string" }, "status": { "description": "Status types for Wiz. Ex: 'OPEN', 'RESOLVED'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "vendor_severity": { "description": "Vendor severity types for Wiz. Ex: 'CRITICAL', 'HIGH', 'MEDIUM', 'LOW'", "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "asset_types", "endpoint_url" ], "type": "object" }, "vulnerability_findings_report.SecretsConfig": { "description": "Wiz vulnerability findings secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" }, "token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "vulnerability_findings_report.SettingsConfig": { "description": "Wiz vulnerability findings settings", "properties": { "asset_status": { "description": "Asset status types for Wiz. Ex: 'ACTIVE', 'INACTIVE'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "asset_types": { "description": "Asset types for Wiz. Ex: 'VIRTUAL_MACHINE', 'CONTAINER', etc.", "items": { "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": false }, "cron": { "description": "Cron string for scheduling the ingest of your input", "type": "string" }, "detection_method": { "description": "Detection method types for Wiz. Ex: 'AGENT', 'CLOUD', 'AGENT_CLOUD'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "endpoint_url": { "description": "Endpoint URL for the Wiz API. Ex: 'https://api.wiz.io/v1/vulnerability-findings'.", "type": "string" }, "status": { "description": "Status types for Wiz. Ex: 'OPEN', 'RESOLVED'.", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" }, "vendor_severity": { "description": "Vendor severity types for Wiz. Ex: 'CRITICAL', 'HIGH', 'MEDIUM', 'LOW'", "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "asset_types", "endpoint_url" ], "type": "object" }, "wiz_audit_logs.SecretsConfig": { "description": "Wiz Audit Logs secrets", "properties": { "client_id": { "$ref": "#/components/schemas/models.Secret" }, "client_secret": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "client_id", "client_secret" ], "type": "object" }, "wiz_audit_logs.SettingsConfig": { "description": "Wiz Audit Logs settings", "properties": { "backfill_start_time": { "description": "Date to start fetching data from up to 180 days. If not specified, a sync of 180 days back is fetched on the first sync. All syncs thereafter will be incremental.", "type": "string" }, "tenant_data_center": { "description": "DataCenter represents the tenant's data center location. Enter a tenant data center, e.g., \"us1\", \"us2\", \"us3\"", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "tenant_data_center" ], "type": "object" }, "zendesk_audit_logs.AuthType": { "description": "AuthType is the type of authentication used for the input", "enum": [ "api_auth", "oauth", "api_auth", "oauth" ], "type": "string", "x-enum-varnames": [ "AuthTypeAPIAuth", "AuthTypeOAuth" ] }, "zendesk_audit_logs.SecretsConfig": { "description": "Zendesk Audit Logs secrets", "properties": { "token": { "$ref": "#/components/schemas/models.Secret" } }, "required": [ "token" ], "type": "object" }, "zendesk_audit_logs.SettingsConfig": { "description": "Zendesk Audit Logs settings", "properties": { "auth_type": { "$ref": "#/components/schemas/zendesk_audit_logs.AuthType" }, "email_address": { "description": "This is the email address registered with your Zendesk account", "type": "string" }, "sub_domain": { "description": "This is the subdomain found in your Zendesk account URL\nFor example, if the URL is https://demo.zendesk.com then the subdomain will be demo", "type": "string" }, "use_synthetic_data": { "description": "Generate synthetic demo data instead of connecting to the real data source.", "type": "boolean" } }, "required": [ "auth_type", "sub_domain" ], "type": "object" } }, "securitySchemes": { "ApiKeyAuth": { "description": "API key authentication", "in": "header", "name": "x-api-key", "type": "apiKey" }, "Bearer": { "description": "Type \"Bearer\" followed by a space and JWT token.", "in": "header", "name": "Authorization", "type": "apiKey" } } }, "info": { "contact": { "email": "support@monad.com", "name": "API Support" }, "description": "Programmatically manage your security data pipelines, configure data sources and destinations, and automate your security operations.\n\n## Base URL\n\n```\nhttps://app.monad.com/api\n```\n\n## Authentication\n\nThe Monad API supports two authentication methods:\n\n### API Key\n\nInclude your API key in the `x-api-key` header:\n\n```bash\ncurl -H \"x-api-key: YOUR_API_KEY\" \\\n https://app.monad.com/api/v2/organizations/{org_id}/pipelines\n```\n\n### JWT Bearer Token\n\nInclude your JWT token in the `Authorization` header:\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_JWT_TOKEN\" \\\n https://app.monad.com/api/v2/organizations/{org_id}/pipelines\n```\n\n## Quick Start\n\nList your pipelines:\n\n```bash\ncurl -H \"x-api-key: YOUR_API_KEY\" \\\n https://app.monad.com/api/v2/organizations/{org_id}/pipelines\n```\n\nCreate a new pipeline:\n\n```bash\ncurl -X POST \\\n -H \"x-api-key: YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"name\": \"My Pipeline\", \"description\": \"Pipeline description\"}' \\\n https://app.monad.com/api/v2/organizations/{org_id}/pipelines\n```\n\n## Rate Limits\n\nAPI requests are subject to rate limiting. If you exceed the rate limit, you'll receive a `429 Too Many Requests` response. Implement exponential backoff in your applications to handle rate limiting gracefully.\n\n## Errors\n\nThe API uses standard HTTP status codes:\n\n| Status Code | Description |\n| ----------- | ------------------------------------------------ |\n| `200` | Success |\n| `201` | Created |\n| `400` | Bad Request - Invalid parameters |\n| `401` | Unauthorized - Invalid or missing authentication |\n| `403` | Forbidden - Insufficient permissions |\n| `404` | Not Found - Resource doesn't exist |\n| `429` | Too Many Requests - Rate limit exceeded |\n| `500` | Internal Server Error |\n", "termsOfService": "https://www.monad.com/terms", "title": "Monad API", "version": "1.0" }, "externalDocs": { "description": "", "url": "" }, "paths": { "/v1/inputs": { "get": { "description": "List inputs", "operationId": "ListInputTypes", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/inputs.ConnectorMeta" }, "type": "array" } } }, "description": "Inputs retrieved successfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List inputs", "tags": [ "Inputs" ] } }, "/v1/inputs/{input_type_id}": { "get": { "description": "Get input config meta", "operationId": "GetInputTypeMeta", "parameters": [ { "description": "Input type ID", "in": "path", "name": "input_type_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.ConnectorMeta" } } }, "description": "Input config meta retrieved successfully" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Input type not found" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get input config meta", "tags": [ "Inputs" ] } }, "/v1/login": { "get": { "description": "Redirects the user to authentication service login page to initiate the login process.", "operationId": "loginHandler", "responses": { "307": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Temporary Redirect" } }, "summary": "Initiate login - This is a development endpoint that is not used by the frontend. You can use this endpoint to initiate the login process and get an access token for swagger.", "tags": [ "Authentication" ] } }, "/v1/login/callback": { "get": { "description": "Displays a page with the access token for the user to include in requests.", "operationId": "loginCallbackHandler", "responses": { "200": { "content": { "text/html": { "schema": { "type": "string" } } }, "description": "Callback page displayed successfully" } }, "summary": "Handle login callback", "tags": [ "Authentication" ] } }, "/v1/login/resend-verification": { "post": { "description": "Resends the email verification to the user's email address", "operationId": "ResendVerificationHandler", "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Verification email sent successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid request body" }, "401": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Resend email verification", "tags": [ "Authentication" ] } }, "/v1/login/token": { "post": { "description": "Retrieve an authentication token from the authentication service using username and password.", "operationId": "GetToken", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routes.LoginRequest", "summary": "login", "description": "Login request" } ] } } }, "description": "Login request", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationtypes.TokenResponse" } } }, "description": "Token retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" }, "default": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Error message" } }, "summary": "Get Authentication token", "tags": [ "Authentication" ] } }, "/v1/oauth/{type_id}/callback": { "get": { "description": "Oauth callback", "operationId": "OAuthCallback", "parameters": [ { "description": "component type ID", "in": "path", "name": "type_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Oauth callback successful" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "oauth handler not found" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Oauth callback", "tags": [ "Oauth" ] } }, "/v1/oauth/{type_id}/{organization_id}": { "get": { "description": "Get oauth redirect", "operationId": "GetOAuthRedirect", "parameters": [ { "description": "component type ID", "in": "path", "name": "type_id", "required": true, "schema": { "type": "string" } }, { "description": "organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Oauth redirect retrieved successfully" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "oauth handler not found" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get oauth redirect", "tags": [ "Oauth" ] } }, "/v1/organizations": { "get": { "description": "List organizations for user", "operationId": "ListUserOrganizations", "parameters": [ { "description": "Limit the number of organizations returned (default: 10)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset the organizations returned (default: 0)", "in": "query", "name": "offset", "schema": { "type": "integer" } }, { "description": "If true, only return organizations that are directly associated with the user, not child organizations (default: false)", "in": "query", "name": "no_children", "schema": { "type": "boolean" } }, { "description": "If provided, only return organizations that are children of the specified parent organization", "in": "query", "name": "parent_organization_id", "schema": { "type": "string" } }, { "description": "If provided, only return organizations with names that contain the search string", "in": "query", "name": "name_search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.OrganizationList" } } }, "description": "Response body for listing organizations" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List organizations for user", "tags": [ "Organizations" ] }, "post": { "description": "Create organization", "operationId": "CreateOrganization", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.CreateOrganizationRequest", "summary": "createOrganizationRequest", "description": "Request body for creating an organization" } } }, "description": "Request body for creating an organization", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Organization" } } }, "description": "Response body for creating an organization" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create organization", "tags": [ "Organizations" ] } }, "/v1/organizations/{organization_id}": { "delete": { "description": "Delete organization", "operationId": "DeleteOrganization", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete organization", "tags": [ "Organizations" ] }, "patch": { "description": "Update organization", "operationId": "UpdateOrganization", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.UpdateOrganizationRequest", "summary": "updateOrganizationRequest", "description": "Request body for updating an organization" } } }, "description": "Request body for updating an organization", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Organization" } } }, "description": "Response body for updating an organization" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update organization", "tags": [ "Organizations" ] } }, "/v1/outputs": { "get": { "description": "List outputs", "operationId": "ListOutputTypes", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/outputs.ConnectorMeta" }, "type": "array" } } }, "description": "Outputs retrieved successfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List outputs", "tags": [ "Outputs" ] } }, "/v1/outputs/{output_type_id}": { "get": { "description": "Get output config meta", "operationId": "GetOutputTypeMeta", "parameters": [ { "description": "Output type ID", "in": "path", "name": "output_type_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.ConnectorMeta" } } }, "description": "Output config meta retrieved successfully" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Output type not found" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get output config meta", "tags": [ "Outputs" ] } }, "/v1/transforms": { "get": { "description": "List transforms", "operationId": "ListTransformTypes", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/operation.Information" }, "type": "array" } } }, "description": "Operation information" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List transforms", "tags": [ "Transforms" ] } }, "/v1/transforms/{transform_type_id}": { "get": { "description": "Get transform metadata", "operationId": "GetTransformTypeMeta", "parameters": [ { "description": "Transform type ID", "in": "path", "name": "transform_type_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Transform metadata" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Transform not found" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get transform metadata", "tags": [ "Transforms" ] } }, "/v1/users": { "get": { "description": "Get your current user", "operationId": "GetActiveUser", "parameters": [ { "description": "Organization ID", "in": "query", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.UserWithRoles" } } }, "description": "Get user successful" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Missing organization_id" }, "403": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Access denied" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get user" } }, "security": [ { "Bearer": [] } ], "summary": "Get your current user", "tags": [ "Users" ] }, "post": { "description": "Create user", "operationId": "CreateUser", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.User" } } }, "description": "Get user success" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Error creating user" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create user", "tags": [ "Users" ] } }, "/v1/{organization_id}/data/{node_id}": { "get": { "description": "Stream data for a specific node within an organization", "operationId": "StreamNodeData", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Node ID", "in": "path", "name": "node_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Data stream" }, "400": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Failed to enable node watching" }, "500": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Failed to create consumer" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Stream node data", "tags": [ "Logs" ] } }, "/v1/{organization_id}/inputs": { "get": { "description": "List configured inputs in organization", "operationId": "ListOrganizationInputs", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit the number of organizations returned (default: DefaultLimit)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset the organizations returned (default: 0)", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.InputList" } } }, "description": "Inputs retrieved successfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List organization inputs", "tags": [ "Organization Inputs" ] } }, "/v1/{organization_id}/inputs/{input_id}": { "delete": { "description": "Delete input", "operationId": "DeleteOrganizationInput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Input ID", "in": "path", "name": "input_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete input" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete input", "tags": [ "Organization Inputs" ] }, "get": { "description": "Get a configured input in organization", "operationId": "GetOrganizationInput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Input ID", "in": "path", "name": "input_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.GetInputResponse" } } }, "description": "Input retrieved successfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get organization input", "tags": [ "Organization Inputs" ] } }, "/v1/{organization_id}/invites": { "post": { "description": "Invite user to organization", "operationId": "InviteUser", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.InviteUserToOrganizationRequest", "summary": "inviteUserToOrganizationRequest", "description": "Request body for inviting a user to an organization" } } }, "description": "Request body for inviting a user to an organization", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "User added to organization" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "429": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Invite user to organization", "tags": [ "Organization Invites" ] } }, "/v1/{organization_id}/logs": { "get": { "description": "Stream logs for an entire organization", "operationId": "StreamOrganizationLogs", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "RFC3339 timestamp to start streaming from", "in": "query", "name": "since", "schema": { "type": "string" } }, { "description": "Duration to start streaming from (e.g., '5h' or '30m')", "in": "query", "name": "last", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Log stream" }, "400": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Invalid 'since' timestamp or 'last' duration format" }, "500": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Stream organization logs", "tags": [ "Logs" ] } }, "/v1/{organization_id}/logs/api": { "get": { "description": "Stream api logs for an organization", "operationId": "StreamOrganizationAPILogs", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "RFC3339 timestamp to start streaming from", "in": "query", "name": "since", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Log stream" }, "400": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Invalid 'since' timestamp format" }, "500": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Stream organization api logs", "tags": [ "Logs" ] } }, "/v1/{organization_id}/logs/pipelines": { "get": { "description": "Stream pipeline logs for an organization", "operationId": "StreamOrganizationPipelinesLogs", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "RFC3339 timestamp to start streaming from", "in": "query", "name": "since", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Log stream" }, "400": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Invalid 'since' timestamp format" }, "500": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Stream organization pipeline logs", "tags": [ "Logs" ] } }, "/v1/{organization_id}/logs/pipelines/{pipeline_id}": { "get": { "description": "Stream logs for a specific pipeline within an organization", "operationId": "StreamPipelineLogs", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "description": "RFC3339 timestamp to start streaming from", "in": "query", "name": "since", "schema": { "type": "string" } }, { "description": "Duration to start streaming from (e.g., '5h' or '30m')", "in": "query", "name": "last", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Log stream" }, "400": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Invalid 'since' timestamp or 'last' duration format" }, "500": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Stream pipeline logs", "tags": [ "Logs" ] } }, "/v1/{organization_id}/logs/pipelines/{pipeline_id}/{node_id}": { "get": { "description": "Stream logs for a specific node within a pipeline and organization", "operationId": "StreamNodeLogs", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "description": "Node ID", "in": "path", "name": "node_id", "required": true, "schema": { "type": "string" } }, { "description": "RFC3339 timestamp to start streaming from", "in": "query", "name": "since", "schema": { "type": "string" } }, { "description": "Duration to start streaming from (e.g., '5h' or '30m')", "in": "query", "name": "last", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Log stream" }, "400": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Invalid 'since' timestamp or 'last' duration format" }, "500": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Stream node logs", "tags": [ "Logs" ] } }, "/v1/{organization_id}/outputs": { "get": { "description": "List outputs", "operationId": "ListOrganizationOutputs", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.OutputList" } } }, "description": "List of outputs" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to marshal outputs" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List configured outputs in organization", "tags": [ "Organization Outputs" ] } }, "/v1/{organization_id}/outputs/{output_id}": { "delete": { "description": "Delete output", "operationId": "DeleteOrganizationOutput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Output ID", "in": "path", "name": "output_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Output deleted successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete output" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete output", "tags": [ "Organization Outputs" ] }, "get": { "description": "Get a configured output in organization", "operationId": "GetOrganizationOutput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Output ID", "in": "path", "name": "output_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.GetOutputResponse" } } }, "description": "Output retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get output" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get a output", "tags": [ "Organization Outputs" ] } }, "/v1/{organization_id}/pipelines": { "get": { "deprecated": true, "description": "List pipelines", "operationId": "ListPipelinesV1", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineList" } } }, "description": "List of pipelines" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid limit or offset" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to list pipelines" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List pipelines", "tags": [ "Pipelines" ] } }, "/v1/{organization_id}/pipelines/{pipeline_id}": { "delete": { "description": "Delete pipeline", "operationId": "DeletePipelineV1", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Pipeline deleted successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete pipeline" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete pipeline", "tags": [ "Pipelines" ] }, "get": { "deprecated": true, "description": "Get pipeline", "operationId": "GetPipeline", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Pipeline" } } }, "description": "Pipeline details" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get pipeline" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get pipeline", "tags": [ "Pipelines" ] }, "patch": { "deprecated": true, "description": "Update pipeline", "operationId": "UpdatePipelineV1", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routes.UpdatePipelineRequest", "summary": "updatePipelineRequest", "description": "Request body for updating a pipeline" } ] } } }, "description": "Request body for updating a pipeline", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Pipeline" } } }, "description": "Response body for updating a pipeline" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to update pipeline" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update pipeline", "tags": [ "Pipelines" ] } }, "/v1/{organization_id}/transforms": { "get": { "description": "List transforms", "operationId": "ListOrganizationTransforms", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.TransformList" } } }, "description": "List of transforms" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to marshal transforms" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List configured transforms in a transform", "tags": [ "Organization Transforms" ] }, "post": { "description": "Create transform", "operationId": "CreateTransform", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routes.CreateTransformRequest", "summary": "createTransformRequest", "description": "Request body for creating a transform" } ] } } }, "description": "Request body for creating a transform", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Transform" } } }, "description": "Transform created successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to create transform" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create transform", "tags": [ "Organization Transforms" ] } }, "/v1/{organization_id}/transforms/{transform_id}": { "delete": { "description": "Delete transform", "operationId": "DeleteOrganizationTransform", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Transform ID", "in": "path", "name": "transform_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete transform" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete transform", "tags": [ "Organization Transforms" ] }, "get": { "description": "Get transform", "operationId": "GetOrganizationTransform", "parameters": [ { "description": "Transform ID", "in": "path", "name": "transform_id", "required": true, "schema": { "type": "string" } }, { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.GetTransformResponse" } } }, "description": "Transform retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get transform" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get transform", "tags": [ "Organization Transforms" ] }, "patch": { "description": "Update transform", "operationId": "UpdateOrganizationTransform", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Transform ID", "in": "path", "name": "transform_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.UpdateTransformRequest", "summary": "updateTransformRequest", "description": "Request body for updating a transform" } } }, "description": "Request body for updating a transform", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Transform" } } }, "description": "Transform updated successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to update transform" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update transform", "tags": [ "Organization Transforms" ] } }, "/v1/{organization_id}/users": { "get": { "description": "List organization users", "operationId": "ListUsers", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.OrganizationUserList" } } }, "description": "List of organization users" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List organization users", "tags": [ "Organization Users" ] }, "post": { "description": "Add user to organization", "operationId": "AddUser", "parameters": [ { "description": "organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.AddUserToOrganizationRequest", "summary": "addOrganizationUserRequest", "description": "Request body for adding a user to an organization" } } }, "description": "Request body for adding a user to an organization", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.OrganizationUser" } } }, "description": "Response body for adding a user to an organization" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Add user to organization", "tags": [ "Organization Users" ] } }, "/v1/{organization_id}/users/leave": { "post": { "description": "Leave organization (self-service removal)", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Leave organization", "tags": [ "Organization Users" ] } }, "/v1/{organization_id}/users/{user_id}": { "delete": { "description": "Remove user from organization", "operationId": "RemoveUser", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } }, { "description": "User Auth Provider ID", "in": "query", "name": "user_auth_provider_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Remove user from organization", "tags": [ "Organization Users" ] }, "patch": { "description": "Update user in organization", "operationId": "UpdateUser", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routes.UpdateUserInOrganizationRequest", "summary": "updateUserInOrganizationRequest", "description": "Request body for updating a user in an organization" } } }, "description": "Request body for updating a user in an organization", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.OrganizationUser" } } }, "description": "Response body for updating a user in an organization" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update user in organization", "tags": [ "Organization Users" ] } }, "/v2/billing/accounts": { "get": { "description": "List Billing Accounts", "operationId": "GetBillingAccounts", "parameters": [ { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.BillingAccountList" } } }, "description": "list billing accounts successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to list Billing Accounts" } }, "security": [ { "Bearer": [] } ], "summary": "List Billing Accounts", "tags": [ "Billing Accounts" ] }, "post": { "description": "Create Billing Account", "operationId": "CreateBillingAccount", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreateBillingAccountRequest", "summary": "createBillingAccountRequest", "description": "Request body for creating a billing account" } ] } } }, "description": "Request body for creating a billing account", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.BillingAccount" } } }, "description": "billing account created successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to create Billing Account" } }, "security": [ { "Bearer": [] } ], "summary": "Create Billing Account", "tags": [ "Billing Accounts" ] } }, "/v2/billing/accounts/{billing_account_id}": { "delete": { "description": "Delete Billing Account", "operationId": "DeleteBillingAccount", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Billing account deleted successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete Billing Account" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Billing Account", "tags": [ "Billing Accounts" ] }, "get": { "description": "Get Billing Account", "operationId": "GetBillingAccount", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.BillingAccount" } } }, "description": "get billing account successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get Billing Account" } }, "security": [ { "Bearer": [] } ], "summary": "Get Billing Account", "tags": [ "Billing Accounts" ] }, "patch": { "description": "Update Billing Account", "operationId": "UpdateBillingAccount", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.UpdateBillingAccountRequest", "summary": "updateBillingAccountRequest", "description": "Request body for updating a billing account" } ] } } }, "description": "Request body for updating a billing account", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.BillingAccount" } } }, "description": "billing account updated successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to update Billing Account" } }, "security": [ { "Bearer": [] } ], "summary": "Update Billing Account", "tags": [ "Billing Accounts" ] } }, "/v2/billing/accounts/{billing_account_id}/roles": { "get": { "description": "Get Billing Account Roles", "operationId": "GetBillingAccountRoles", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/models.BillingAccountRole" }, "type": "array" } } }, "description": "get billing account roles successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get Billing Account Roles" } }, "security": [ { "Bearer": [] } ], "summary": "Get Billing Account Roles", "tags": [ "Billing Accounts RBAC" ] }, "post": { "description": "Create Billing Account Role", "operationId": "CreateBillingAccountRole", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreateBillingAccountRoleRequest", "summary": "createBillingAccountRoleRequest", "description": "Create Billing Account Role Request" } ] } } }, "description": "Create Billing Account Role Request", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.BillingAccountRole" } } }, "description": "create billing account role successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to create Billing Account Role" } }, "security": [ { "Bearer": [] } ], "summary": "Create Billing Account Role", "tags": [ "Billing Accounts RBAC" ] } }, "/v2/billing/accounts/{billing_account_id}/roles/{role_id}": { "delete": { "description": "Delete Billing Account Role", "operationId": "DeleteBillingAccountRole", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } }, { "description": "Role ID", "in": "path", "name": "role_id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "delete billing account role successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete Billing Account Role" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Billing Account Role", "tags": [ "Billing Accounts RBAC" ] }, "get": { "description": "Get Billing Account Role", "operationId": "GetBillingAccountRole", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } }, { "description": "Role ID", "in": "path", "name": "role_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.BillingAccountRole" } } }, "description": "get billing account role successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get Billing Account Role" } }, "security": [ { "Bearer": [] } ], "summary": "Get Billing Account Role", "tags": [ "Billing Accounts RBAC" ] }, "patch": { "description": "Update Billing Account Role", "operationId": "UpdateBillingAccountRole", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } }, { "description": "Role ID", "in": "path", "name": "role_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.UpdateBillingAccountRoleRequest", "summary": "updateBillingAccountRoleRequest", "description": "Update Billing Account Role Request" } ] } } }, "description": "Update Billing Account Role Request", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.BillingAccountRole" } } }, "description": "update billing account role successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to update Billing Account Role" } }, "security": [ { "Bearer": [] } ], "summary": "Update Billing Account Role", "tags": [ "Billing Accounts RBAC" ] } }, "/v2/billing/accounts/{billing_account_id}/roles/{role_id}/users": { "post": { "description": "Add a user to a billing account role", "operationId": "CreateBillingAccountUserRole", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } }, { "description": "Role ID", "in": "path", "name": "role_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreatebillingAccountUserRoleRequest", "summary": "createbillingAccountUserRoleRequest", "description": "Create Billing Account User Role Request" } ] } } }, "description": "Create Billing Account User Role Request", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "create billing account user role successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to create Billing Account User Role" } }, "security": [ { "Bearer": [] } ], "summary": "Create Billing Account User Role", "tags": [ "Billing Accounts RBAC" ] } }, "/v2/billing/accounts/{billing_account_id}/roles/{role_id}/users/{user_id}": { "delete": { "description": "Remove a user to a billing account role", "operationId": "DeleteBillingAccountUserRole", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } }, { "description": "Role ID", "in": "path", "name": "role_id", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "delete billing account user role successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete Billing Account User Role" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Billing Account User Role", "tags": [ "Billing Accounts RBAC" ] } }, "/v2/billing/accounts/{billing_account_id}/subscription": { "delete": { "description": "Cancel Billing Account Subscription", "operationId": "CancelBillingAccountSubscription", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": {} }, "description": "Billing subscription cancelled successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to cancel billing account subscription" } }, "security": [ { "Bearer": [] } ], "summary": "Cancel Billing Account Subscription", "tags": [ "Billing Products" ] }, "get": { "description": "Get Billing Account Subscription", "operationId": "GetBillingAccountSubscription", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.BillingProduct" } } }, "description": "billing subscription retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get billing account subscription" } }, "security": [ { "Bearer": [] } ], "summary": "Get Billing Account Subscription", "tags": [ "Billing Products" ] }, "post": { "description": "Create Billing Account Subscription", "operationId": "CreateBillingAccountSubscription", "parameters": [ { "description": "Billing Account ID", "in": "path", "name": "billing_account_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreateBillingAccountSubscriptionRequest", "summary": "createBillingAccountSubscriptionRequest", "description": "Request body for creating a billing subscription" } ] } } }, "description": "Request body for creating a billing subscription", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.CreateBillingAccountSubscriptionResponse" } } }, "description": "billing subscription intialized successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to created billing account subscription" } }, "security": [ { "Bearer": [] } ], "summary": "Create Billing Account Subscription", "tags": [ "Billing Products" ] } }, "/v2/billing/permissions": { "get": { "description": "Get Billing Permissions", "operationId": "GetBillingPermissions", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/models.BillingAccountPermission" }, "type": "array" } } }, "description": "get billing account permissions successfull" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get Billing Account Permissions" } }, "security": [ { "Bearer": [] } ], "summary": "Get Billing Permissions", "tags": [ "Billing Accounts RBAC" ] } }, "/v2/billing/products": { "get": { "description": "List Billing Products", "operationId": "GetBillingProducts", "parameters": [ { "description": "Show inactive products", "in": "query", "name": "show_inactive", "schema": { "type": "boolean" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.BillingProductList" } } }, "description": "billing product listed successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to list billing products" } }, "security": [ { "Bearer": [] } ], "summary": "List Billing Products", "tags": [ "Billing Products" ] } }, "/v2/conditions": { "get": { "description": "List conditions", "operationId": "ListConditions", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/leafconditions.Info" }, "type": "array" } } }, "description": "Conditions information" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List conditions", "tags": [ "Conditions" ] } }, "/v2/quotas": { "get": { "description": "List quotas for a given billing account or organization id.", "operationId": "ListQuotas", "parameters": [ { "description": "Billing Account ID", "in": "query", "name": "billing_account_id", "schema": { "type": "string" } }, { "description": "Organization ID", "in": "query", "name": "organization_id", "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.QuotaList" } } }, "description": "list quotas successful" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to list quotas" } }, "security": [ { "Bearer": [] } ], "summary": "List quotas", "tags": [ "Quotas" ] } }, "/v2/sandbox/condition": { "post": { "description": "Apply a condition to a JSON record", "operationId": "ApplyConditionV2", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.ApplyConditionRequest", "summary": "request", "description": "Condition and record" } ] } } }, "description": "Condition and record", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.ApplyConditionResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request parameters" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Apply condition to record", "tags": [ "Condition Sandbox" ] } }, "/v2/sandbox/template": { "get": { "description": "Get a list of all valid record type templates", "operationId": "ListTemplates", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.ListTemplatesResponse" } } }, "description": "List of template names" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List available templates", "tags": [ "Transform Sandbox" ] }, "post": { "description": "Generate a sample record using the specified template type", "operationId": "GenerateRecord", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.GenerateRecordRequest", "summary": "request", "description": "Record generation parameters" } ] } } }, "description": "Record generation parameters", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.GenerateRecordResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request parameters" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Generate sample record", "tags": [ "Transform Sandbox" ] } }, "/v2/sandbox/transform": { "post": { "description": "Apply a transformation configuration to a JSON record", "operationId": "ApplyTransformationV2", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.ApplyTransformationRequest", "summary": "request", "description": "Transform configuration and record" } ] } } }, "description": "Transform configuration and record", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.ApplyTransformationResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request parameters" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Apply transformation to record", "tags": [ "Transform Sandbox" ] } }, "/v2/transforms/repository": { "get": { "description": "List transforms from repository with pagination", "operationId": "ListTransformRepository", "parameters": [ { "description": "Number of items to return (default: 10)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Number of items to skip (default: 0)", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.TransformsRepositoryList" } } }, "description": "Transforms retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to list transforms" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List transforms", "tags": [ "Transforms Repository" ] } }, "/v2/transforms/repository/{transform_id}": { "get": { "description": "Get detailed information about a specific transform from repository", "operationId": "GetTransformRepositoryDetails", "parameters": [ { "description": "Transform ID", "in": "path", "name": "transform_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.TransformsRepositoryTransform" } } }, "description": "Transform details retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get transform details" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get transform details", "tags": [ "Transforms Repository" ] } }, "/v2/{organization_id}/api_keys": { "get": { "description": "List API keys", "operationId": "ListAPIKeys", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.APIKeyList" } } }, "description": "List of API keys" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to list API keys" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List API keys", "tags": [ "Organization API Keys" ] }, "post": { "description": "Create API key", "operationId": "CreateAPIKey", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreateAPIKeyRequest", "summary": "createAPIKeyRequest", "description": "Request body for creating an API key" } ] } } }, "description": "Request body for creating an API key", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.APIKeyWithToken" } } }, "description": "API key created successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to create API key" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create API key", "tags": [ "Organization API Keys" ] } }, "/v2/{organization_id}/api_keys/{api_key_id}": { "delete": { "description": "Delete API key", "operationId": "DeleteAPIKey", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "API Key ID", "in": "path", "name": "api_key_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "API key deleted successfully" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "API key not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete API key" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete API key", "tags": [ "Organization API Keys" ] }, "get": { "description": "Get API key", "operationId": "GetAPIKey", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "API Key ID", "in": "path", "name": "api_key_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.APIKey" } } }, "description": "API key details" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "API key not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get API key" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get API key", "tags": [ "Organization API Keys" ] }, "patch": { "description": "Update API key", "operationId": "UpdateAPIKey", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "API Key ID", "in": "path", "name": "api_key_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.UpdateAPIKeyRequest", "summary": "updateAPIKeyRequest", "description": "Request body for updating an API key" } ] } } }, "description": "Request body for updating an API key", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.APIKey" } } }, "description": "API key updated successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to update API key" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update API key", "tags": [ "Organization API Keys" ] } }, "/v2/{organization_id}/api_keys/{api_key_id}/regenerate": { "post": { "description": "Regenerates an API key by creating a new one with the same metadata and deleting the old one", "operationId": "RegenerateAPIKey", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "API Key ID", "in": "path", "name": "api_key_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.APIKeyWithToken" } } }, "description": "New API key generated successfully" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "API key not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to regenerate API key" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Regenerate API key", "tags": [ "Organization API Keys" ] } }, "/v2/{organization_id}/inputs": { "post": { "description": "Create a new input with configuration including secrets handling", "operationId": "CreateInput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Test connection before creating the input", "in": "query", "name": "test_connection", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreateInputRequest", "summary": "createInputRequest", "description": "Input configuration" } ] } } }, "description": "Input configuration", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Input" } } }, "description": "Input created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, input type, configuration validation error, or secret processing error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create input", "tags": [ "Organization Inputs" ] } }, "/v2/{organization_id}/inputs/test-connection": { "post": { "description": "Tests the connection for a given input type and configuration", "operationId": "TestInputConnection", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.TestInputConnectionRequest", "summary": "testConnectionRequest", "description": "Input configuration to test" } ] } } }, "description": "Input configuration to test", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.SuccessResponse" } } }, "description": "Connection test successful" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, input type, or configuration" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Test input connection", "tags": [ "Organization Inputs" ] } }, "/v2/{organization_id}/inputs/{input_id}": { "patch": { "description": "Update an existing input with new configuration including secrets handling", "operationId": "UpdateInput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Input ID", "in": "path", "name": "input_id", "required": true, "schema": { "type": "string" } }, { "description": "Test connection before creating the input", "in": "query", "name": "test_connection", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.UpdateInputRequest", "summary": "updateInputRequest", "description": "Input configuration update" } ] } } }, "description": "Input configuration update", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Input" } } }, "description": "Input updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, input type, configuration validation error, or secret processing error" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Input not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update input", "tags": [ "Organization Inputs" ] }, "put": { "description": "Replace an existing input with new configuration including secrets handling", "operationId": "ReplaceInput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Input ID", "in": "path", "name": "input_id", "required": true, "schema": { "type": "string" } }, { "description": "Test connection before creating the input", "in": "query", "name": "test_connection", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.PutInputRequest", "summary": "updateInputRequest", "description": "Input configuration update" } ] } } }, "description": "Input configuration update", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Input" } } }, "description": "Input updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, input type, configuration validation error, or secret processing error" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Input not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Replace input", "tags": [ "Organization Inputs" ] } }, "/v2/{organization_id}/metrics": { "get": { "description": "Get time series metrics for an organization", "operationId": "GetOrganizationMetrics", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Metric to retrieve (ingress_bytes|egress_bytes|ingress_records|egress_records|errors)", "in": "query", "name": "metric", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 6 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } }, { "description": "Resolution of the data, default determined by time window", "in": "query", "name": "resolution", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineMetrics" } } }, "description": "Organization metrics" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Organization not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get organization metrics", "tags": [ "Organizations Metrics" ] } }, "/v2/{organization_id}/metrics/pipelines/{pipeline_id}": { "get": { "description": "Get time series metrics for a pipeline", "operationId": "GetPipelineMetrics", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "description": "Metric to retrieve (ingress_bytes|egress_bytes|ingress_records|egress_records|errors)", "in": "query", "name": "metric", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 6 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } }, { "description": "Resolution of the data, default determined by time window", "in": "query", "name": "resolution", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineMetrics" } } }, "description": "Pipeline metrics" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Pipeline not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get pipeline metrics", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/metrics/pipelines/{pipeline_id}/{node_id}": { "get": { "description": "Get pipeline node metrics", "operationId": "GetPipelineNodeMetrics", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "description": "Node ID", "in": "path", "name": "node_id", "required": true, "schema": { "type": "string" } }, { "description": "Metric to retrieve (ingress_bytes|egress_bytes|ingress_records|egress_records|errors)", "in": "query", "name": "metric", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 6 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } }, { "description": "Resolution of the data, default determined by time window", "in": "query", "name": "resolution", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineMetrics" } } }, "description": "Pipeline node metrics" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Pipeline or node not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get pipeline node metrics", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/metrics/storage-types": { "get": { "description": "Get time series metrics grouped by storage type for an organization", "operationId": "GetStorageTypeMetrics", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Metric to retrieve (egress_bytes|egress_records|errors)", "in": "query", "name": "metric", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 6 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } }, { "description": "Resolution of the data, default determined by time window", "in": "query", "name": "resolution", "schema": { "type": "string" } }, { "description": "Filter by billing type (billable|non_billable)", "in": "query", "name": "billing_type", "schema": { "type": "string" } }, { "description": "Filter to specific pipeline", "in": "query", "name": "pipeline_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.StorageTypeTimeSeriesResponse" } } }, "description": "Storage type metrics" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Organization not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get storage type metrics", "tags": [ "Organizations Storage Cost" ] } }, "/v2/{organization_id}/metrics/storage-types/details": { "get": { "description": "Get detailed metrics for each individual output, including egress and associated input", "operationId": "GetStorageTypeDetails", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 6 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } }, { "description": "Filter by billing type (billable|non_billable)", "in": "query", "name": "billing_type", "schema": { "type": "string" } }, { "description": "Filter to specific pipeline", "in": "query", "name": "pipeline_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.StorageTypeDetailsResponse" } } }, "description": "Storage type output details" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Organization not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get storage type output details", "tags": [ "Organizations Storage Cost" ] } }, "/v2/{organization_id}/metrics/storage-types/summary": { "get": { "description": "Get aggregated cost and usage summary by storage type", "operationId": "GetStorageTypeSummary", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 6 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } }, { "description": "Filter by billing type (billable|non_billable)", "in": "query", "name": "billing_type", "schema": { "type": "string" } }, { "description": "Filter to specific pipeline", "in": "query", "name": "pipeline_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.StorageTypeSummaryResponse" } } }, "description": "Storage type cost summary" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Organization not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get storage type cost summary", "tags": [ "Organizations Storage Cost" ] } }, "/v2/{organization_id}/metrics/storage-types/{storage_type}/details": { "get": { "description": "Get detailed metrics for each individual output of a specific storage type", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Storage type (e.g., s3, dev-null, bigquery)", "in": "path", "name": "storage_type", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 6 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } }, { "description": "Filter by billing type (billable|non_billable)", "in": "query", "name": "billing_type", "schema": { "type": "string" } }, { "description": "Filter to specific pipeline", "in": "query", "name": "pipeline_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.StorageTypeDetailsResponse" } } }, "description": "Storage type output details" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Organization or storage type not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get storage type output details by type", "tags": [ "Organizations Storage Cost" ] } }, "/v2/{organization_id}/metrics/storage-types/{storage_type}/summary": { "get": { "description": "Get aggregated cost and usage summary for a specific storage type", "operationId": "GetStorageTypeSummaryByType", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Storage type (e.g., s3, dev-null, bigquery)", "in": "path", "name": "storage_type", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 6 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } }, { "description": "Filter by billing type (billable|non_billable)", "in": "query", "name": "billing_type", "schema": { "type": "string" } }, { "description": "Filter to specific pipeline", "in": "query", "name": "pipeline_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.StorageTypeSummaryResponse" } } }, "description": "Storage type cost summary" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Organization or storage type not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get storage type cost summary by type", "tags": [ "Organizations" ] } }, "/v2/{organization_id}/outputs": { "post": { "description": "Create a new output with configuration including secrets handling", "operationId": "CreateOutput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Test connection before creating the input", "in": "query", "name": "test_connection", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreateOutputRequest", "summary": "createOutputRequest", "description": "Output configuration" } ] } } }, "description": "Output configuration", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Output" } } }, "description": "Output created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, output type, configuration validation error, or secret processing error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create output", "tags": [ "Organization Outputs" ] } }, "/v2/{organization_id}/outputs/test-connection": { "post": { "description": "Tests the connection for a given output type and configuration", "operationId": "TestOutputConnection", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.TestOutputConnectionRequest", "summary": "testConnectionRequest", "description": "Output configuration to test" } ] } } }, "description": "Output configuration to test", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.SuccessResponse" } } }, "description": "Connection test successful" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, output type, or configuration" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Test output connection", "tags": [ "Organization Outputs" ] } }, "/v2/{organization_id}/outputs/{output_id}": { "patch": { "description": "Update an existing output with new configuration including secrets handling", "operationId": "UpdateOutput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Output ID", "in": "path", "name": "output_id", "required": true, "schema": { "type": "string" } }, { "description": "Test connection before creating the input", "in": "query", "name": "test_connection", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.UpdateOutputRequest", "summary": "updateOutputRequest", "description": "Output configuration update" } ] } } }, "description": "Output configuration update", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Output" } } }, "description": "Output updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, output type, configuration validation error, or secret processing error" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Output not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update output", "tags": [ "Organization Outputs" ] }, "put": { "description": "Replace an existing output with new configuration including secrets handling", "operationId": "ReplaceOutput", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Output ID", "in": "path", "name": "output_id", "required": true, "schema": { "type": "string" } }, { "description": "Test connection before creating the input", "in": "query", "name": "test_connection", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.PutOutputRequest", "summary": "updateOutputRequest", "description": "Output configuration update" } ] } } }, "description": "Output configuration update", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Output" } } }, "description": "Output updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, output type, configuration validation error, or secret processing error" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Output not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Replace output", "tags": [ "Organization Outputs" ] } }, "/v2/{organization_id}/pipeline_summary": { "get": { "description": "Get status of all pipelines for an organization", "operationId": "GetOrganizationSummary", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 24 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.getOrganizationSummaryResponse" } } }, "description": "Organization Pipeline Summary" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get pipelines for organization" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get status of all pipelines for an organization", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/pipelines": { "get": { "description": "List pipelines", "operationId": "ListPipelines", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } }, { "description": "Include the status of the pipeline nodes", "in": "query", "name": "include_status", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineList" } } }, "description": "List of pipelines" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid limit or offset" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to list pipelines" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List pipelines", "tags": [ "Pipelines" ] }, "post": { "description": "Create a new pipeline with specified configuration", "operationId": "CreatePipeline", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreatePipelineRequest", "summary": "createPipelineRequest", "description": "Request body for creating a pipeline" } ] } } }, "description": "Request body for creating a pipeline", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineConfigV2" } } }, "description": "Pipeline created successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body or Failed to create pipeline" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create pipeline", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/pipelines/metrics": { "get": { "description": "Get aggregated ingress and egress metrics for specific pipelines", "operationId": "GetMetricsForPipelines", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Comma-separated list of pipeline IDs", "in": "query", "name": "pipeline_ids", "required": true, "schema": { "type": "string" } }, { "description": "Resolution for metrics (default: 5m)", "in": "query", "name": "resolution", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.MetricsResponse" } } }, "description": "Pipeline metrics data" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request error" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get metrics for specific pipelines", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/pipelines/statuses": { "get": { "description": "Retrieve the status of pipelines within an organization for a specified time period.", "operationId": "GetPipelinesStatuses", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of pipelines to return (default is 10)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset for pagination (default is 0)", "in": "query", "name": "offset", "schema": { "type": "integer" } }, { "description": "Start time (RFC3339 format) for status metrics (default: 24 hours ago)", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "End time (RFC3339 format) for status metrics (default: now)", "in": "query", "name": "end", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/routesV2.pipelineWithStatus" }, "type": "array" } } }, "description": "List of pipelines with status" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid query parameters or time range" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to retrieve pipeline status" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get pipeline status", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/pipelines/{pipeline_id}": { "delete": { "description": "Delete pipeline", "operationId": "DeletePipeline", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Pipeline deleted successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete pipeline" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete pipeline", "tags": [ "Pipelines" ] }, "get": { "description": "Retrieve a specific pipeline configuration by pipeline ID", "operationId": "GetPipelineConfig", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "description": "Include the status of the pipeline nodes", "in": "query", "name": "include_status", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineConfigV2" } } }, "description": "Pipeline configuration retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get pipeline" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get pipeline configuration", "tags": [ "Pipelines" ] }, "patch": { "description": "Update an existing pipeline with the specified configuration", "operationId": "UpdatePipeline", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.UpdatePipelineRequest", "summary": "updatePipelineRequest", "description": "Request body for updating a pipeline" } ] } } }, "description": "Request body for updating a pipeline", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineConfigV2" } } }, "description": "Pipeline updated successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to update pipeline" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update pipeline", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/pipelines/{pipeline_id}/edges/{edge_id}": { "patch": { "description": "Enable or disable a pipeline edge", "operationId": "UpdatePipelineEdge", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "description": "Edge ID", "in": "path", "name": "edge_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.PatchPipelineEdgeRequest", "summary": "patchPipelineEdgeRequest", "description": "Request body" } ] } } }, "description": "Request body", "required": true }, "responses": { "204": { "description": "Edge updated successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Edge not found in pipeline" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to update pipeline edge" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update pipeline edge", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/pipelines/{pipeline_id}/status": { "get": { "description": "Get pipeline status", "operationId": "GetPipelineStatus", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "description": "Metrics to retrieve (all|health|ingress_bytes|egress_bytes|ingress_records|egress_records|backpressure)", "in": "query", "name": "metrics", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "ISO3339 start time, default 24 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineStatus" } } }, "description": "Pipeline status" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get pipeline" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get pipeline status", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/pipelines/{pipeline_id}/status/{node_id}": { "get": { "description": "Get pipeline node status", "operationId": "GetPipelineNodeStatus", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "description": "Node ID", "in": "path", "name": "node_id", "required": true, "schema": { "type": "string" } }, { "description": "Metrics to retrieve (all|health|ingress_bytes|egress_bytes|ingress_records|egress_records|backpressure)", "in": "query", "name": "metrics", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "ISO3339 start time, default 24 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineNodeStatus" } } }, "description": "Pipeline Node status" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get pipeline node status" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get pipeline node status", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/pipelines/{pipeline_id}/trigger": { "post": { "description": "Manually trigger a cron-scheduled pipeline to run", "operationId": "TriggerPipeline", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Pipeline triggered successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid request or pipeline not cron-based" }, "403": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Insufficient permissions" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Pipeline not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Trigger pipeline manually", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/pipelines/{pipeline_id}/{node_id}/metrics": { "get": { "deprecated": true, "description": "Get pipeline node metrics", "operationId": "GetPipelineNodeMetricsV2", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Pipeline ID", "in": "path", "name": "pipeline_id", "required": true, "schema": { "type": "string" } }, { "description": "Node ID", "in": "path", "name": "node_id", "required": true, "schema": { "type": "string" } }, { "description": "Metric to retrieve (ingress_bytes|egress_bytes|ingress_records|egress_records|errors)", "in": "query", "name": "metric", "required": true, "schema": { "type": "string" } }, { "description": "ISO3339 start time, default 6 hours ago", "in": "query", "name": "start", "schema": { "type": "string" } }, { "description": "ISO3339 end time, default now", "in": "query", "name": "end", "schema": { "type": "string" } }, { "description": "Resolution of the data, default determined by time window", "in": "query", "name": "resolution", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PipelineMetrics" } } }, "description": "Pipeline node metrics" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Pipeline or node not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get pipeline node metrics", "tags": [ "Pipelines" ] } }, "/v2/{organization_id}/quotas": { "get": { "description": "Returns a paginated list of quotas with their latest usage for a given organization", "operationId": "GetQuotasByOrganizationID", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.QuotaList" } } }, "description": "List of quotas" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid limit or offset" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to list quotas" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get Organization Quotas", "tags": [ "Organization Quotas" ] } }, "/v2/{organization_id}/roles": { "get": { "description": "List roles with their associated permissions", "operationId": "ListRoles", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit the number of roles returned (default: 10)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset the roles returned (default: 0)", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.RoleWithPermissionsList" } } }, "description": "Roles retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Error listing roles" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List roles", "tags": [ "Roles" ] }, "post": { "description": "Create a new role with permissions", "operationId": "CreateRole", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreateRoleV2Request", "summary": "createRoleRequest", "description": "Request body for creating a role" } ] } } }, "description": "Request body for creating a role", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.RoleWithPermissions" } } }, "description": "Role created successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to create role" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create role", "tags": [ "Roles" ] } }, "/v2/{organization_id}/roles/permissions": { "get": { "description": "List all available permissions in the system", "operationId": "ListPermissions", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit the number of permissions returned (default: 10)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset the permissions returned (default: 0)", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.PermissionList" } } }, "description": "Permissions retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Error listing permissions" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List permissions", "tags": [ "Permissions" ] } }, "/v2/{organization_id}/roles/{role_id}": { "delete": { "description": "Delete a role", "operationId": "DeleteRole", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Role ID", "in": "path", "name": "role_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to delete role" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete role", "tags": [ "Roles" ] }, "get": { "description": "Get a role with its associated permissions", "operationId": "GetRole", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Role ID", "in": "path", "name": "role_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.RoleWithPermissions" } } }, "description": "Role retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Error getting role" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get role", "tags": [ "Roles" ] }, "patch": { "description": "Update a role and its permissions", "operationId": "UpdateRole", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Role ID", "in": "path", "name": "role_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.UpdateRoleV2Request", "summary": "updateRoleRequest", "description": "Request body for updating a role" } ] } } }, "description": "Request body for updating a role", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.RoleWithPermissions" } } }, "description": "Role updated successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid JSON request body" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to update role" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update role", "tags": [ "Roles" ] } }, "/v2/{organization_id}/sandbox/transform": { "post": { "description": "Apply a transformation configuration to a JSON record, resolving secret references from the organization", "operationId": "ApplyTransformation", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.ApplyTransformationRequest", "summary": "request", "description": "Transform configuration and record" } ] } } }, "description": "Transform configuration and record", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.ApplyTransformationResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request parameters" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Apply transformation to record", "tags": [ "Transform Sandbox" ] } }, "/v2/{organization_id}/secrets": { "get": { "description": "Lists all secrets for the specified organization including inputs and outputs that use them", "operationId": "ListSecrets", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit number of results", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset results", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.SecretWithComponentsList" } } }, "description": "OK" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List secrets with components", "tags": [ "Secrets" ] }, "post": { "description": "Creates a new secret for the specified organization", "operationId": "CreateSecret", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreateOrUpdateSecretRequest", "summary": "secret", "description": "Secret to create" } ] } } }, "description": "Secret to create", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.SecretResponse" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create secret", "tags": [ "Secrets" ] } }, "/v2/{organization_id}/secrets/{secret_id}": { "delete": { "description": "Deletes a specific secret by ID", "operationId": "DeleteSecret", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Secret ID", "in": "path", "name": "secret_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Secret not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete secret", "tags": [ "Secrets" ] }, "get": { "description": "Gets a specific secret by ID including inputs and outputs that use it", "operationId": "GetSecret", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Secret ID", "in": "path", "name": "secret_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.SecretWithComponents" } } }, "description": "OK" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Secret not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get secret with components", "tags": [ "Secrets" ] }, "patch": { "description": "Updates a specific secret by ID", "operationId": "UpdateSecret", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Secret ID", "in": "path", "name": "secret_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.CreateOrUpdateSecretRequest", "summary": "secret", "description": "Secret updates" } ] } } }, "description": "Secret updates", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV2.SecretResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Secret not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update secret", "tags": [ "Secrets" ] } }, "/v2/{organization_id}/storage-type-cost": { "get": { "description": "Get per-organization cost configuration for storage types", "operationId": "GetStorageTypeCost", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.StorageTypeCostConfig" } } }, "description": "Storage type cost" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Organization not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get storage type cost", "tags": [ "Organizations Storage Cost" ] }, "put": { "description": "Update per-organization cost configuration for storage types", "operationId": "SetStorageTypeCost", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV2.SetStorageTypeCostRequest", "summary": "body", "description": "Cost configuration" } ] } } }, "description": "Cost configuration", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.StorageTypeCostConfig" } } }, "description": "Updated storage type cost" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Bad request" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Organization not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Set storage type cost", "tags": [ "Organizations Storage Cost" ] } }, "/v3/alert_rules": { "get": { "description": "List all available alert rule types with their configuration metadata", "operationId": "ListAlertRuleTypes", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/alerts.AlertMeta" }, "type": "array" } } }, "description": "Alert rule types retrieved successfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List alert rule types", "tags": [ "Alert Rules" ] } }, "/v3/alert_rules/{alert_rule_type_id}": { "get": { "description": "Get configuration metadata for a specific alert rule type by its type ID", "operationId": "GetAlertRuleConfigMeta", "parameters": [ { "description": "Alert Rule Type ID", "in": "path", "name": "alert_rule_type_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alerts.AlertMeta" } } }, "description": "Alert rule type config metadata retrieved successfully" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Alert rule type not found" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get alert rule type config metadata", "tags": [ "Alert Rules" ] } }, "/v3/feature_flags": { "get": { "description": "Get feature flags for the authenticated user", "operationId": "GetFeatureFlags", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV3.GetFeatureFlagResponse" } } }, "description": "Feature flags retrieved successfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get feature flags", "tags": [ "Feature Flags" ] } }, "/v3/pipeline_edges/edge_condition_operator_types": { "get": { "description": "Returns the conditional types for edge conditions", "operationId": "GetPipelineEdgeConditionOperatorTypes", "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Conditions returned succesfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Conditional types for edge conditions", "tags": [ "Pipelines" ] } }, "/v3/pipeline_edges/edge_condition_rules": { "get": { "description": "Returns the rules for edge conditions", "operationId": "GetPipelineEdgeConditionRules", "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Rules returned succesfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Rules for edge conditions", "tags": [ "Pipelines" ] } }, "/v3/transforms/repository": { "get": { "description": "List transforms from repository index", "operationId": "ListCommunityTransforms", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/community_transforms_internal.TransformsIndex" } } }, "description": "Transforms retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to list transforms" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List community transforms", "tags": [ "Transforms Repository" ] } }, "/v3/transforms/repository/export": { "post": { "description": "Export transform to YAML format", "operationId": "ExportTransform", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/community_transforms_internal.TransformConfig", "summary": "exportRequest", "description": "Transform to export and optional metadata" } ] } } }, "description": "Transform to export and optional metadata", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "YAML-formatted transform" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid request" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to export transform" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Export transform to YAML", "tags": [ "Transforms Repository" ] } }, "/v3/transforms/repository/import": { "post": { "description": "Import transform from YAML file", "operationId": "ImportTransform", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "text/plain": { "schema": { "title": "transform", "type": "string" } } }, "description": "YAML transform definition", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV3.ImportTransformResponse" } } }, "description": "Transform imported successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid YAML or transform validation failed" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to import transform" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Import transform from YAML", "tags": [ "Transforms Repository" ] } }, "/v3/transforms/repository/{transform_id}": { "get": { "description": "Get detailed information about a specific transform from repository", "operationId": "GetTransformDetailsFromRepository", "parameters": [ { "description": "Transform ID", "in": "path", "name": "transform_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/community_transforms_internal.TransformConfig" } } }, "description": "Transform details retrieved successfully" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Transform not found" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get transform details" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get transform details", "tags": [ "Transforms Repository" ] } }, "/v3/users/mfa": { "get": { "description": "Get MFA enrollment status and methods for a user", "operationId": "GetMFAStatus", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV3.MFAStatusResponse" } } }, "description": "MFA status retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get MFA status", "tags": [ "Users" ] }, "post": { "description": "Enable MFA for a user and create enrollment ticket (OTP only)", "operationId": "EnableMFA", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationtypes.MFAEnrollmentTicket" } } }, "description": "MFA enrollment ticket created successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Enable MFA", "tags": [ "Users" ] } }, "/v3/{organization_id}/alert_rules": { "get": { "description": "Retrieve all alert rules for an organization", "operationId": "ListAlertRules", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.AlertRuleList" } } }, "description": "List of alert rules retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Get all alert rules", "tags": [ "Alert Rules" ] }, "post": { "description": "Create a new alert rule with the provided details", "operationId": "CreateAlertRule", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.CreateAlertRuleRequest", "summary": "createAlertRuleRequest", "description": "Request body for creating an alert rule" } ] } } }, "description": "Request body for creating an alert rule", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.AlertRule" } } }, "description": "Alert rule created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a new alert rule", "tags": [ "Alert Rules" ] } }, "/v3/{organization_id}/alert_rules/{alert_rule_id}": { "delete": { "description": "Delete an existing alert rule", "operationId": "DeleteAlertRule", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Alert Rule ID to delete", "in": "path", "name": "alert_rule_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Alert rule deleted successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Alert rule not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete alert rule", "tags": [ "Alert Rules" ] }, "get": { "description": "Retrieve an alert rule by its ID", "operationId": "GetAlertRuleByID", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Alert Rule ID to retrieve", "in": "path", "name": "alert_rule_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.AlertRule" } } }, "description": "Alert rule retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Alert rule not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Get alert rule by ID", "tags": [ "Alert Rules" ] }, "put": { "description": "Update an existing alert rule", "operationId": "UpdateAlertRule", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Alert Rule ID to update", "in": "path", "name": "alert_rule_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.UpdateAlertRuleRequest", "summary": "updateAlertRuleRequest", "description": "Request body for updating an alert rule" } ] } } }, "description": "Request body for updating an alert rule", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.AlertRule" } } }, "description": "Alert rule updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Update alert rule", "tags": [ "Alert Rules" ] } }, "/v3/{organization_id}/alerts": { "get": { "description": "Get list of recent historical alerts for an organization", "operationId": "ListAlerts", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Comma-separated alert rule IDs", "in": "query", "name": "rule_ids", "schema": { "type": "string" } }, { "description": "Comma-separated severity levels", "in": "query", "name": "severities", "schema": { "type": "string" } }, { "description": "Comma-separated pipeline IDs", "in": "query", "name": "pipeline_ids", "schema": { "type": "string" } }, { "description": "Resource type filter", "in": "query", "name": "resource_type", "schema": { "type": "string" } }, { "description": "Specific resource ID", "in": "query", "name": "resource_id", "schema": { "type": "string" } }, { "description": "RFC3339 timestamp for start time", "in": "query", "name": "since", "schema": { "type": "string" } }, { "description": "RFC3339 timestamp for end time", "in": "query", "name": "until", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV3.AlertList" } } }, "description": "Paginated alerts" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid parameters" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "List alerts with pagination", "tags": [ "Alerts" ] } }, "/v3/{organization_id}/alerts/stream": { "get": { "description": "Stream alerts for an organization using Server-Sent Events", "operationId": "StreamAlerts", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "RFC3339 timestamp to start streaming from", "in": "query", "name": "since", "schema": { "type": "string" } }, { "description": "Duration to start streaming from (e.g., '5m', '1h', '24h')", "in": "query", "name": "last", "schema": { "type": "string" } }, { "description": "Comma-separated alert rule IDs", "in": "query", "name": "rule_ids", "schema": { "type": "string" } }, { "description": "Comma-separated severity levels", "in": "query", "name": "severities", "schema": { "type": "string" } }, { "description": "Comma-separated resource IDs", "in": "query", "name": "resource_ids", "schema": { "type": "string" } }, { "description": "Resource type filter", "in": "query", "name": "resource_type", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Alert stream" }, "400": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Invalid parameters" }, "500": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Stream alerts in real-time", "tags": [ "Alerts" ] } }, "/v3/{organization_id}/connections": { "get": { "description": "Retrieve all connections", "operationId": "ListConnections", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.ConnectionList" } } }, "description": "List of connections retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Get all connections", "tags": [ "Connections" ] }, "post": { "description": "Create a new connection with the provided details", "operationId": "CreateConnection", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.CreateConnectionRequest", "summary": "createConnectionRequest", "description": "Request body for creating a connection" } ] } } }, "description": "Request body for creating a connection", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Connection" } } }, "description": "Connection created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a new connection", "tags": [ "Connections" ] } }, "/v3/{organization_id}/connections/{connection_id}": { "delete": { "description": "Delete an existing connection", "operationId": "DeleteConnection", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Connection ID to delete", "in": "path", "name": "connection_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Connection deleted successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete connection", "tags": [ "Connections" ] }, "get": { "description": "Retrieve a connection by its ID", "operationId": "GetConnectionByID", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Connection ID to retrieve", "in": "path", "name": "connection_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Connection" } } }, "description": "Connection retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Connection not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Get connection by ID", "tags": [ "Connections" ] }, "patch": { "description": "Update an existing connection", "operationId": "UpdateConnection", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Connection ID to update", "in": "path", "name": "connection_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.UpdateConnectionRequest", "summary": "updateConnectionRequest", "description": "Request body for updating a connection" } ] } } }, "description": "Request body for updating a connection", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Connection" } } }, "description": "Connection updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] } ], "summary": "Update connection", "tags": [ "Connections" ] } }, "/v3/{organization_id}/enrichments": { "get": { "description": "List all enrichments for an organization", "operationId": "ListEnrichments", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Number of results to return (default 100)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Number of results to skip (default 0)", "in": "query", "name": "offset", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.EnrichmentList" } } }, "description": "List of enrichments" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List enrichments", "tags": [ "Organization Enrichments" ] }, "post": { "description": "Create a new enrichment with configuration including secrets handling", "operationId": "CreateEnrichment", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Test connection before creating the enrichment", "in": "query", "name": "test_connection", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.CreateEnrichmentRequest", "summary": "createEnrichmentRequest", "description": "Enrichment configuration" } ] } } }, "description": "Enrichment configuration", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Enrichment" } } }, "description": "Enrichment created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, enrichment type, configuration validation error, or secret processing error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create enrichment", "tags": [ "Organization Enrichments" ] } }, "/v3/{organization_id}/enrichments/sandbox": { "post": { "description": "Apply a enrichment configuration to a JSON record", "operationId": "EnrichmentSandbox", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.EnrichmentSandboxRequest", "summary": "request", "description": "Enrichment configuration and record" } ] } } }, "description": "Enrichment configuration and record", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV3.EnrichmentSandboxResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request parameters" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Apply enrichment to record", "tags": [ "Enrichment Sandbox" ] } }, "/v3/{organization_id}/enrichments/test-connection": { "post": { "description": "Tests the connection for a given enrichment type and configuration", "operationId": "TestEnrichmentConnection", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.TestEnrichmentConnectionRequest", "summary": "testConnectionRequest", "description": "Enrichment configuration to test" } ] } } }, "description": "Enrichment configuration to test", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV3.SuccessResponse" } } }, "description": "Connection test successful" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, enrichment type, or configuration" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Test enrichment connection", "tags": [ "Organization Enrichments" ] } }, "/v3/{organization_id}/enrichments/{enrichment_id}": { "delete": { "description": "Delete an enrichment by ID", "operationId": "DeleteEnrichment", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Enrichment ID", "in": "path", "name": "enrichment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV3.SuccessResponse" } } }, "description": "Enrichment deleted successfully" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Enrichment not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete enrichment", "tags": [ "Organization Enrichments" ] }, "get": { "description": "Get an enrichment by ID", "operationId": "GetEnrichment", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Enrichment ID", "in": "path", "name": "enrichment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV3.GetEnrichmentResponse" } } }, "description": "Enrichment details" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Enrichment not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get enrichment", "tags": [ "Organization Enrichments" ] }, "patch": { "description": "Update an existing enrichment with new configuration including secrets handling", "operationId": "UpdateEnrichment", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Enrichment ID", "in": "path", "name": "enrichment_id", "required": true, "schema": { "type": "string" } }, { "description": "Test connection before updating the enrichment", "in": "query", "name": "test_connection", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.UpdateEnrichmentRequest", "summary": "updateEnrichmentRequest", "description": "Enrichment configuration update" } ] } } }, "description": "Enrichment configuration update", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Enrichment" } } }, "description": "Enrichment updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, enrichment type, configuration validation error, or secret processing error" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Enrichment not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update enrichment", "tags": [ "Organization Enrichments" ] }, "put": { "description": "Replace an existing enrichment with new configuration including secrets handling", "operationId": "ReplaceEnrichment", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Enrichment ID", "in": "path", "name": "enrichment_id", "required": true, "schema": { "type": "string" } }, { "description": "Test connection before updating the enrichment", "in": "query", "name": "test_connection", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.PutEnrichmentRequest", "summary": "updateEnrichmentRequest", "description": "Enrichment configuration update" } ] } } }, "description": "Enrichment configuration update", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.Enrichment" } } }, "description": "Enrichment updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body, enrichment type, configuration validation error, or secret processing error" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Enrichment not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Replace enrichment", "tags": [ "Organization Enrichments" ] } }, "/v3/{organization_id}/enrichments_meta": { "get": { "description": "List available enrichment types", "operationId": "ListEnrichmentTypes", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/enrichment.ConnectorMeta" }, "type": "array" } } }, "description": "Enrichments retrieved successfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List enrichments", "tags": [ "Enrichments" ] } }, "/v3/{organization_id}/enrichments_meta/{enrichment_type_id}": { "get": { "description": "Get enrichment config meta", "operationId": "GetEnrichmentTypeMeta", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Enrichment type ID", "in": "path", "name": "enrichment_type_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enrichment.ConnectorMeta" } } }, "description": "Enrichment config meta retrieved successfully" }, "404": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Enrichment type not found" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get enrichment config meta", "tags": [ "Enrichments" ] } }, "/v3/{organization_id}/kv_lookup/metadata": { "get": { "description": "Get metadata of the KV lookup bucket for a given organization and component, including key count, byte usage, last ingested time, max bytes, and TTL", "operationId": "GetKVLookupMetadata", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Component ID", "in": "query", "name": "component_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvlookup.GetMetadataResponse" } } }, "description": "Metadata retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get KV lookup metadata" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get KV lookup metadata", "tags": [ "Key Value Store" ] } }, "/v3/{organization_id}/kv_lookup/sample": { "get": { "description": "Get a sample of entries from the NATS KV lookup bucket for a given organization and component", "operationId": "GetKVLookupSampleEntries", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Component ID", "in": "query", "name": "component_id", "required": true, "schema": { "type": "string" } }, { "description": "Number of sample entries to return", "in": "query", "name": "num_entries", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/kvlookup.KVEntry" }, "type": "array" } } }, "description": "Sample entries retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Invalid num_entries parameter" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get KV lookup sample entries" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get KV lookup sample entries", "tags": [ "Key Value Store" ] } }, "/v3/{organization_id}/kv_lookup/value": { "get": { "description": "Get the value associated with a specific key from the NATS KV lookup bucket for a given organization and component", "operationId": "GetValueFromKvStore", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Component ID", "in": "query", "name": "component_id", "required": true, "schema": { "type": "string" } }, { "description": "Key to look up", "in": "query", "name": "key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvlookup.KVEntry" } } }, "description": "Value retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Failed to get value from KV lookup" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Get value by key from KV lookup", "tags": [ "Key Value Store" ] } }, "/v3/{organization_id}/organizations": { "get": { "description": "List child organizations for the given parent organization. These are surfaced as \"teams\" in the UI.", "operationId": "ListChildOrganizations", "parameters": [ { "description": "Parent Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Limit the number of organizations returned (default: 10)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Offset the organizations returned (default: 0)", "in": "query", "name": "offset", "schema": { "type": "integer" } }, { "description": "If provided, only return organizations with names that contain the search string", "in": "query", "name": "name_search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.UserOrganizationList" } } }, "description": "List of child organizations" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List child organizations (teams)", "tags": [ "Organizations" ] }, "post": { "description": "Create a new child organization under the given parent organization. Known as a \"team\" in the UI.", "operationId": "CreateChildOrganization", "parameters": [ { "description": "Parent Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.CreateChildOrganizationRequest", "summary": "createChildOrganizationRequest", "description": "Request body" } ] } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Organization" } } }, "description": "Created child organization" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create child organization (team)", "tags": [ "Organizations" ] } }, "/v3/{organization_id}/organizations/{child_organization_id}": { "delete": { "description": "Delete a child organization under the given parent organization. Known as a \"team\" in the UI.", "operationId": "DeleteChildOrganization", "parameters": [ { "description": "Parent Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Child Organization ID", "in": "path", "name": "child_organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Child organization deleted successfully" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Child organization not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Delete child organization (team)", "tags": [ "Organizations" ] }, "patch": { "description": "Update a child organization under the given parent organization. Known as a \"team\" in the UI.", "operationId": "UpdateChildOrganization", "parameters": [ { "description": "Parent Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "description": "Child Organization ID", "in": "path", "name": "child_organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.UpdateChildOrganizationRequest", "summary": "updateChildOrganizationRequest", "description": "Request body" } ] } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_monad-inc_core_pkg_types_models.Organization" } } }, "description": "Updated child organization" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Child organization not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Update child organization (team)", "tags": [ "Organizations" ] } }, "/v3/{organization_id}/transform_recommendations": { "post": { "description": "Analyze security data and provide transformation recommendations", "operationId": "CreateTransformRecommendation", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" }, { "$ref": "#/components/schemas/routesV3.TransformRecommendationRequest", "summary": "transformRecommendationRequest", "description": "Security data to analyze" } ] } } }, "description": "Security data to analyze", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routesV3.SecurityDataAnalysis" } } }, "description": "Transform recommendation created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Internal server error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responder.ErrorResponse" } } }, "description": "Service unavailable (API key not configured)" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "Create transform recommendation", "tags": [ "Transforms Recommendations" ] } }, "/v3/{organization_id}/transform_recommendations/optimizers": { "get": { "description": "List available transform optimizers", "operationId": "ListAvailableOptimizers", "parameters": [ { "description": "Organization ID", "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/routesV3.optimizerType" }, "type": "array" } } }, "description": "Transform recommendation created successfully" } }, "security": [ { "Bearer": [] }, { "ApiKeyAuth": [] } ], "summary": "List available transform optimizers", "tags": [ "Transforms Recommendations" ] } } }, "openapi": "3.1.0", "servers": [ { "url": "https://app.monad.com" } ] ,"tags":[{"name":"Authentication","description":"Authentication endpoints"},{"name":"Oauth","description":"OAuth endpoints"},{"name":"Roles","description":"Role management endpoints"},{"name":"Permissions","description":"Permission management endpoints"},{"name":"Organization API Keys","description":"Organization API key management"},{"name":"Inputs","description":"Input management endpoints"},{"name":"Organization Inputs","description":"Organization-specific input endpoints"},{"name":"Outputs","description":"Output management endpoints"},{"name":"Organization Outputs","description":"Organization-specific output endpoints"},{"name":"Transforms","description":"Transform management endpoints"},{"name":"Organization Transforms","description":"Organization-specific transform endpoints"},{"name":"Transforms Repository","description":"Community transforms repository"},{"name":"Transforms Recommendations","description":"Transform recommendations"},{"name":"Transform Sandbox","description":"Transform sandbox for testing"},{"name":"Enrichments","description":"Enrichment management endpoints"},{"name":"Organization Enrichments","description":"Organization-specific enrichment endpoints"},{"name":"Enrichment Sandbox","description":"Enrichment sandbox for testing"},{"name":"Condition Sandbox","description":"Condition sandbox for testing"},{"name":"Pipelines","description":"Pipeline management endpoints"},{"name":"Conditions","description":"Condition management endpoints"},{"name":"Alerts","description":"Alert management endpoints"},{"name":"Alert Rules","description":"Alert rule management"},{"name":"Key Value Store","description":"Key-value store operations"},{"name":"Users","description":"User management endpoints"},{"name":"Organizations","description":"Organization management endpoints"},{"name":"Organization Users","description":"Organization user management"},{"name":"Organization Invites","description":"Organization invitation management"},{"name":"Organization Quotas","description":"Organization quota management"},{"name":"Organizations Metrics","description":"Organization metrics"},{"name":"Organizations Storage Cost","description":"Organization storage cost tracking"},{"name":"Billing Accounts","description":"Billing account management"},{"name":"Billing Accounts RBAC","description":"Billing account role-based access control"},{"name":"Billing Products","description":"Billing product management"},{"name":"Secrets","description":"Secret management endpoints"},{"name":"Logs","description":"Log streaming endpoints"},{"name":"Connections","description":"Connection management"},{"name":"Feature Flags","description":"Feature flag management"},{"name":"Quotas","description":"Quota management"}],"x-tagGroups":[{"name":"Authentication \u0026 Authorization","tags":["Authentication","Oauth","Roles","Permissions","Organization API Keys"]},{"name":"Inputs","tags":["Inputs","Organization Inputs"]},{"name":"Outputs","tags":["Outputs","Organization Outputs"]},{"name":"Transforms","tags":["Transforms","Organization Transforms","Transforms Repository","Transforms Recommendations","Transform Sandbox"]},{"name":"Enrichments","tags":["Enrichments","Organization Enrichments","Enrichment Sandbox"]},{"name":"Pipelines","tags":["Pipelines","Conditions"]},{"name":"Alerts","tags":["Alerts","Alert Rules"]},{"name":"Organizations","tags":["Users","Organizations","Organization Users","Organization Invites","Organization Quotas","Organizations Metrics"]},{"name":"Billing","tags":["Billing Accounts","Billing Accounts RBAC","Billing Products"]},{"name":"Secrets","tags":["Secrets"]},{"name":"Logs","tags":["Logs"]},{"name":"Utilities","tags":["Connections","Key Value Store","Feature Flags","Quotas","Organizations Storage Cost"]}]}