v1

latestOpenAPI 3.1.02026-07-26289714404.6 KB
Configuration

For creating or updating log forwarding configuration

Log forwarding configuration is used to forward logs to external services

put/log-forwarding/configurations

Request body

type'SPLUNK' | 'NEWRELIC' | 'DATADOG' | 'SUMOLOGIC' | 'LOGZIO' | 'CORALOGIX' | 'GOOGLE_CLOUD_LOGGING' | 'GRAFANA_LOKI' | 'CLOUDWATCH' | 'S3' required
valueobject required

A JSON representation of the log forwarding configuration.

  • For SPLUNK type use: { url: "your-url", token: "your-token", index: "your-index" }

  • For NEWRELIC type use: { url: "your-url", apiKey: "your-api-key" }

  • For DATADOG type use: { host: "your-host", port: "your-port (number)", apiKey: "your-api-key" }

  • For SUMOLOGIC type use: { url: "your-url" }

  • For LOGZIO type use: { host: "your-host", token: "your-token", protocol: "http or https", port: "your-port (number)" }

  • For CORALOGIX type use: { host: "your-host", token: "your-token", appName: "your-app-name", subSystemName: "your-subsystem-name" }

  • For GOOGLE_CLOUD_LOGGING type use: { projectId: "your-project-id", logName: "your-log-name", serviceAccountCredentials: "your-service-account-credentials" }

  • For GRAFANA_LOKI type use: { host: "your-host", requiresAuthentication: "true or false", username: "your-username", password: "your-password" }

  • For CLOUDWATCH type use: { roleArn: "your-role-arn", awsRegion: "your-region", sessionDuration?: "session-duration-in-seconds", logGroupNamePrefix?: "your-log-group-prefix" }

  • For S3 type use: { bucketName: "your-bucket-name", awsRegion: "your-aws-region", roleArn: "your-role-arn", bucketPath?: "your-bucket-path", sessionDuration?: "session-duration-in-seconds" }

auditLogForwardingboolean required
deploymentLogForwardingboolean required
encryptionMethod'kms'
organizationIdstring required
projectIdstring

Response

type'SPLUNK' | 'NEWRELIC' | 'DATADOG' | 'SUMOLOGIC' | 'LOGZIO' | 'CORALOGIX' | 'GOOGLE_CLOUD_LOGGING' | 'GRAFANA_LOKI' | 'CLOUDWATCH' | 'S3' required
{"stackTrail":"components:schemas:LogForwardingConfigurationWithoutValue:properties:value","oasType":"schema","type":"unknown"}
auditLogForwardingboolean required
deploymentLogForwardingboolean required
idstring required
namestring required
organizationIdstring required
projectIdstring
updatedAtstring date-time required