Method: properties.testSettings

Full name: projects.locations.instances.moduleSettings.properties.testSettings

Tests the provided configuration properties. Use this method to validate settings (e.g., connectivity for email servers) before applying them. Currently, this validation is primarily supported for email settings modules.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1beta/{parent}/properties:testSettings

Path parameters

Parameters
parent

string

Required. The parent resource where the module settings are located. Format: projects/{project}/locations/{location}/instances/{instance}/moduleSettings/{module}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "properties": [
    {
      object (ModuleSettingsProperty)
    }
  ]
}
Fields
properties[]

object (ModuleSettingsProperty)

Required. Properties to test Format: projects/{project}/locations/{location}/instances/{instance}/moduleSettings/{module}/properties/{property}

Response body

Response message for testSettings.

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

JSON representation 
{
  "success": boolean,
  "message": string
}
Fields
success

boolean

Did the test finish successfully
message

string

Execution message, if provided

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 parent resource:

  • chronicle.moduleSettingsProperties.testSettings

For more information, see the IAM documentation.