Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
logsDataForwardingManagement

Create an S3 data forwarding rule.

Create a data forwarding rule to send data from a Partition or Scheduled View to an S3 bucket.

post/v1/logsDataForwarding/rules

Request body

indexIdstring required

The id of the Partition or Scheduled View the rule applies to.

destinationIdstring required

The data forwarding destination id.

enabledboolean

True when the data forwarding rule is enabled.

fileFormatstring

Specify the path prefix to a directory in the S3 bucket and how to format the file name.

payloadSchemastring

Schema for the payload. Default value of the payload schema is "allFields" for scheduled view, and "builtInFields" for partition. "raw" payloadSchema should be used in conjunction with "text" format and vice-versa.

formatstring

Format of the payload. Default format will be "csv". "text" format should be used in conjunction with "raw" payloadSchema and vice-versa.

Example request

{
  "indexId": "1",
  "destinationId": "1",
  "enabled": true,
  "fileFormat": "{index}_{day}_{hour}_{minute}_{second}",
  "payloadSchema": "builtInFields",
  "format": "csv"
}

Response

The data forwarding rule was created.

indexIdstring required

The id of the Partition or Scheduled View the rule applies to.

destinationIdstring required

The data forwarding destination id.

enabledboolean

True when the data forwarding rule is enabled.

fileFormatstring

Specify the path prefix to a directory in the S3 bucket and how to format the file name.

payloadSchemastring

Schema for the payload. Default value of the payload schema is "allFields" for scheduled view, and "builtInFields" for partition. "raw" payloadSchema should be used in conjunction with "text" format and vice-versa.

formatstring

Format of the payload. Default format will be "csv". "text" format should be used in conjunction with "raw" payloadSchema and vice-versa.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring

The unique identifier of the data forwarding rule.

Example response

{
  "indexId": "1",
  "destinationId": "1",
  "enabled": true,
  "fileFormat": "{index}_{day}_{hour}_{minute}_{second}",
  "payloadSchema": "builtInFields",
  "format": "csv",
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8",
  "id": "1"
}