Method: properties.testSettings

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

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

The method tests the configured module settings, and by this ensures that all settings of the module were configured properly.

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

POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{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 the following OAuth scope:

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

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.