Method: legacySystemMetadata.placeholders

Full name: projects.locations.instances.legacySystemMetadata.placeholders

Legacy Get Placeholder Names.

HTTP request


Path parameters

Parameters
instance

string

Required. The name of the parent resource, which is the SecOps instance to get Placeholders for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
placeholderCategory

enum (PlaceholderCategory)

Required. The category of placeholders requested.
searchTerm

string

Optional. A search term used for querying placeholders.
shouldRemovePrefix

boolean

Optional. Skip field type prefix.
simulation

boolean

Optional. Request for playbook simulation. Can be provided if the Category is ENTITY. Helps to understand if we are looking for entities that are part of a playbook simulation.
originalWorkflowIdentifier

string

Optional. Simulated playbook identifier. Can be provided if the Category is ENTITY. To reference the specific playbook that is simulated so the placeholders can look for entity names within it.

Request body

The request body must be empty.

Response body

Response for legacySystemMetadata.placeholders.

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

JSON representation 
{
  "items": [
    string
  ],
  "totalSize": integer
}
Fields
items[]

string

Output only. The list of placeholder names.
totalSize

integer

The total number of results matching the request.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

PlaceholderCategory

Categories for placeholders used in the system.

Enums
PLACEHOLDER_CATEGORY_UNSPECIFIED Unspecified placeholder category.
ALERT Alert placeholder category.
CASE Case placeholder category.
ENTITY Entity placeholder category.
ENVIRONMENT Environment placeholder category.
EVENT Event placeholder category.
ENVIRONMENT_PARAMETER Environment parameter placeholder category.
GENERAL General placeholder category.