Method: legacySystem.legacyGetMaximumDataRetentionValue

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
• Authorization scopes
• IAM Permissions

Full name: projects.locations.instances.legacySystem.legacyGetMaximumDataRetentionValue

Returns the maximum data retention period allowed by the current license, expressed in months.

HTTP request

Choose a location:

africa-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-central2 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu

GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacySystem:legacyGetMaximumDataRetentionValue

Path parameters

Parameters
instance	string Required. The instance to get the maximum data retention value for. Format: projects/{project}/locations/{location}/instances/{instance}/legacySystem:legacyGetMaximumDataRetentionValue

Request body

The request body must be empty.

Response body

Response message for legacySystem.legacyGetMaximumDataRetentionValue.

If successful, the response body contains data with the following structure:

JSON representation
{ "payload": integer }

Fields
payload	integer The maximum data retention value time in months.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/chronicle
• https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

• chronicle.legacySystem.getMaximumDataRetentionValue

For more information, see the IAM documentation.