diff --git a/content/en/api/v2/logs-archives/examples.json b/content/en/api/v2/logs-archives/examples.json index 0018e7c3f67..dac05839b28 100644 --- a/content/en/api/v2/logs-archives/examples.json +++ b/content/en/api/v2/logs-archives/examples.json @@ -159,7 +159,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of archives.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

object <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination.

\n
\n
\n
\n
\n
\n

account_id [required]

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

The path of the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

The state of the archive. \nAllowed enum values: UNKNOWN,WORKING,FAILING,WORKING_AUTH_LEGACY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The archive ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of archives.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

object <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination. You must provide either access_key_id alone, or both account_id and role_name together.

\n
\n
\n
\n
\n
\n

access_key_id

\n
\n

string

\n

The access key ID for the integration. Can be used alone as an alternative to providing both account_id and role_name.

\n
\n \n
\n
\n
\n
\n
\n

account_id

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name

\n
\n

string

\n

The name of the role to assume for the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

The state of the archive. \nAllowed enum values: UNKNOWN,WORKING,FAILING,WORKING_AUTH_LEGACY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The archive ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -224,7 +224,7 @@ "type": "archives" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

object <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination.

\n
\n
\n
\n
\n
\n

account_id [required]

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

The path of the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

The state of the archive. \nAllowed enum values: UNKNOWN,WORKING,FAILING,WORKING_AUTH_LEGACY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The archive ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

object <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination. You must provide either access_key_id alone, or both account_id and role_name together.

\n
\n
\n
\n
\n
\n

access_key_id

\n
\n

string

\n

The access key ID for the integration. Can be used alone as an alternative to providing both account_id and role_name.

\n
\n \n
\n
\n
\n
\n
\n

account_id

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name

\n
\n

string

\n

The name of the role to assume for the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

The state of the archive. \nAllowed enum values: UNKNOWN,WORKING,FAILING,WORKING_AUTH_LEGACY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The archive ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -302,7 +302,7 @@ "type": "archives" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

 <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination.

\n
\n
\n
\n
\n
\n

account_id [required]

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

The path of the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

 <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination. You must provide either access_key_id alone, or both account_id and role_name together.

\n
\n
\n
\n
\n
\n

access_key_id

\n
\n

string

\n

The access key ID for the integration. Can be used alone as an alternative to providing both account_id and role_name.

\n
\n \n
\n
\n
\n
\n
\n

account_id

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name

\n
\n

string

\n

The name of the role to assume for the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" } }, "DeleteLogsArchive": { @@ -386,7 +386,7 @@ "type": "archives" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

object <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination.

\n
\n
\n
\n
\n
\n

account_id [required]

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

The path of the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

The state of the archive. \nAllowed enum values: UNKNOWN,WORKING,FAILING,WORKING_AUTH_LEGACY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The archive ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

object <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination. You must provide either access_key_id alone, or both account_id and role_name together.

\n
\n
\n
\n
\n
\n

access_key_id

\n
\n

string

\n

The access key ID for the integration. Can be used alone as an alternative to providing both account_id and role_name.

\n
\n \n
\n
\n
\n
\n
\n

account_id

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name

\n
\n

string

\n

The name of the role to assume for the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

The state of the archive. \nAllowed enum values: UNKNOWN,WORKING,FAILING,WORKING_AUTH_LEGACY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The archive ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -467,7 +467,7 @@ "type": "archives" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

object <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination.

\n
\n
\n
\n
\n
\n

account_id [required]

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

The path of the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

The state of the archive. \nAllowed enum values: UNKNOWN,WORKING,FAILING,WORKING_AUTH_LEGACY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The archive ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

object <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination. You must provide either access_key_id alone, or both account_id and role_name together.

\n
\n
\n
\n
\n
\n

access_key_id

\n
\n

string

\n

The access key ID for the integration. Can be used alone as an alternative to providing both account_id and role_name.

\n
\n \n
\n
\n
\n
\n
\n

account_id

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name

\n
\n

string

\n

The name of the role to assume for the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

The state of the archive. \nAllowed enum values: UNKNOWN,WORKING,FAILING,WORKING_AUTH_LEGACY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The archive ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -553,7 +553,7 @@ "type": "archives" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

 <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination.

\n
\n
\n
\n
\n
\n

account_id [required]

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

The path of the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of an archive.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the archive.

\n
\n
\n
\n
\n
\n

compression_method

\n
\n

enum

\n

The type of compression for the archive. \nAllowed enum values: GZIP,ZSTD

default: GZIP

\n
\n \n
\n
\n
\n
\n
\n

destination [required]

\n
\n

 <oneOf>

\n

An archive's destination.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Azure archive destination.

\n
\n
\n
\n
\n
\n

container [required]

\n
\n

string

\n

The container where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The Azure archive's integration destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

A client ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

A tenant ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

storage_account [required]

\n
\n

string

\n

The associated storage account.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Azure archive destination. \nAllowed enum values: azure

default: azure

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The GCS archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The GCS archive's integration destination.

\n
\n
\n
\n
\n
\n

client_email [required]

\n
\n

string

\n

A client email.

\n
\n \n
\n
\n
\n
\n
\n

project_id

\n
\n

string

\n

A project ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the GCS archive destination. \nAllowed enum values: gcs

default: gcs

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The S3 archive destination.

\n
\n
\n
\n
\n
\n

bucket [required]

\n
\n

string

\n

The bucket where the archive will be stored.

\n
\n \n
\n
\n
\n
\n
\n

encryption

\n
\n

object

\n

The S3 encryption settings.

\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

An Amazon Resource Name (ARN) used to identify an AWS KMS key.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of S3 encryption for a destination. \nAllowed enum values: NO_OVERRIDE,SSE_S3,SSE_KMS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

integration [required]

\n
\n

object

\n

The S3 Archive's integration destination. You must provide either access_key_id alone, or both account_id and role_name together.

\n
\n
\n
\n
\n
\n

access_key_id

\n
\n

string

\n

The access key ID for the integration. Can be used alone as an alternative to providing both account_id and role_name.

\n
\n \n
\n
\n
\n
\n
\n

account_id

\n
\n

string

\n

The account ID for the integration.

\n
\n \n
\n
\n
\n
\n
\n

role_name

\n
\n

string

\n

The name of the role to assume for the integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

path

\n
\n

string

\n

The archive path.

\n
\n \n
\n
\n
\n
\n
\n

storage_class

\n
\n

enum

\n

The storage class where the archive will be stored. \nAllowed enum values: STANDARD,STANDARD_IA,ONEZONE_IA,INTELLIGENT_TIERING,GLACIER_IR

default: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the S3 archive destination. \nAllowed enum values: s3

default: s3

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

include_tags

\n
\n

boolean

\n

To store the tags in the archive, set the value "true".\nIf it is set to "false", the tags will be deleted when the logs are sent to the archive.

\n
\n \n
\n
\n
\n
\n
\n

lookup_attributes

\n
\n

[string]

\n

An array of attributes to use as lookup keys for the archive.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The archive name.

\n
\n \n
\n
\n
\n
\n
\n

partitioning_attributes

\n
\n

[string]

\n

An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The archive query/filter. Logs matching this query are included in the archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_max_scan_size_in_gb

\n
\n

int64

\n

Maximum scan size for rehydration from this archive.

\n
\n \n
\n
\n
\n
\n
\n

rehydration_tags

\n
\n

[string]

\n

An array of tags to add to rehydrated logs from an archive.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

The type of the resource. The value should always be archives.

default: archives

\n
\n \n
\n
\n
\n
" } }, "RemoveRoleFromArchive": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 038cf41516b..750f5da43a2 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -56141,19 +56141,21 @@ components: - client_email type: object LogsArchiveIntegrationS3: - description: The S3 Archive's integration destination. + description: >- + The S3 Archive's integration destination. You must provide either `access_key_id` alone, or both `account_id` and `role_name` together. properties: + access_key_id: + description: The access key ID for the integration. Can be used alone as an alternative to providing both `account_id` and `role_name`. + example: AKIAIOSFODNN7EXAMPLE + type: string account_id: description: The account ID for the integration. example: "123456789012" type: string role_name: - description: The path of the integration. + description: The name of the role to assume for the integration. example: role-name type: string - required: - - role_name - - account_id type: object LogsArchiveOrder: description: A ordered list of archive IDs. @@ -147111,6 +147113,18 @@ paths: - team:intake - team:app type: archives + s3_access_key_id: + value: + data: + attributes: + destination: + bucket: my-bucket + integration: + access_key_id: AKIAIOSFODNN7EXAMPLE + type: s3 + name: Nginx Archive + query: source:nginx + type: archives schema: $ref: "#/components/schemas/LogsArchiveCreateRequest" description: The definition of the new archive. @@ -147136,6 +147150,21 @@ paths: state: WORKING id: 00000000-0000-0000-0000-000000000002 type: archives + s3_access_key_id: + value: + data: + attributes: + destination: + bucket: my-bucket + integration: + access_key_id: AKIAIOSFODNN7EXAMPLE + type: s3 + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: 00000000-0000-0000-0000-000000000002 + type: archives schema: $ref: "#/components/schemas/LogsArchive" description: OK @@ -147288,6 +147317,18 @@ paths: - team:intake - team:app type: archives + s3_access_key_id: + value: + data: + attributes: + destination: + bucket: my-bucket + integration: + access_key_id: AKIAIOSFODNN7EXAMPLE + type: s3 + name: Nginx Archive + query: source:nginx + type: archives schema: $ref: "#/components/schemas/LogsArchiveCreateRequest" description: New definition of the archive. @@ -147313,6 +147354,21 @@ paths: state: WORKING id: 00000000-0000-0000-0000-000000000004 type: archives + s3_access_key_id: + value: + data: + attributes: + destination: + bucket: my-bucket + integration: + access_key_id: AKIAIOSFODNN7EXAMPLE + type: s3 + include_tags: false + name: Nginx Archive + query: source:nginx + state: WORKING + id: 00000000-0000-0000-0000-000000000004 + type: archives schema: $ref: "#/components/schemas/LogsArchive" description: OK