Method: instances.verifyReferenceList

Full name: projects.locations.instances.verifyReferenceList

VerifyReferenceList validates list content and returns line errors, if any.

HTTP request

POST https://chronicle.googleapis.com/v1alpha/{instance}:verifyReferenceList

Path parameters

Parameters
instance

string

Required. The Chronicle instance associated with the request. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "syntax_type": enum (ReferenceListSyntaxType),
  "entries": [
    {
      object (ReferenceListEntry)
    }
  ]
}
Fields
syntax_type

enum (ReferenceListSyntaxType)

Required. Type (format) of list lines.
entries[]

object (ReferenceListEntry)

Required. The entries of the reference list. Each line may be either an item in the list or a comment.

Response body

VerifyListResponse response message.

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

JSON representation 
{
  "success": boolean,
  "errors": [
    {
      object (ReferenceListError)
    }
  ]
}
Fields
success

boolean

Validity of list - true if no errors found.
errors[]

object (ReferenceListError)

Line-level errors causing the list to be invalid.

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

  • chronicle.referenceLists.verifyReferenceList

For more information, see the IAM documentation.

ReferenceListError

The error generated when verifying the reference list.

JSON representation 
{
  "line_number": integer,
  "error_message": string
}
Fields
line_number

integer

1-indexed line number where the error occurs. General list errors are indexed at -1.
error_message

string

Message explaining why the line is invalid.