2026-11-21
▼ ▲ aiplatform.projects.locations.agentAnomalyDetectionScopes.list
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Description : Required. The resource name of the Location to list the AgentAnomalyDetectionScopes from. Format: `projects/{project}/locations/{location}`
pageSize
Description : Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 AgentAnomalyDetectionScopes will be returned.
Location : query
Type : integer
Format : int32
pageToken
Type : string
Location : query
Description : Optional. The standard list page token.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/agentAnomalyDetectionScopes
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes
Description : Lists AgentAnomalyDetectionScopes in a Location.
▼ ▲ aiplatform.projects.locations.agentAnomalyDetectionScopes.get
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/agentAnomalyDetectionScopes/[^/]+$
Description : Required. The name of the AgentAnomalyDetectionScope resource. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`
Location : path
Type : string
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes/{agentAnomalyDetectionScopesId}
Description : Gets the details of a specific AgentAnomalyDetectionScope.
▼ ▲ aiplatform.projects.locations.agentAnomalyDetectionScopes.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes/{agentAnomalyDetectionScopesId}
Description : Deletes a specific AgentAnomalyDetectionScope.
Parameter Order : name
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the AgentAnomalyDetectionScope resource to be deleted. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agentAnomalyDetectionScopes/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
▼ ▲ aiplatform.projects.locations.agentAnomalyDetectionScopes.create
Path : v1/{+parent}/agentAnomalyDetectionScopes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes
Description : Creates a new AgentAnomalyDetectionScope.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : parent
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The resource name of the Location to create the AgentAnomalyDetectionScope in. Format: `projects/{project}/locations/{location}`
Required : Yes
Location : path
Type : string
agentAnomalyDetectionScopeId
Type : string
Description : Required. The ID to use for the AgentAnomalyDetectionScope, which will become the final component of the AgentAnomalyDetectionScope's resource name. This value should be 1-63 characters, and valid characters are /[a-z]([a-z0-9-]{0,61}[a-z0-9])?/.
Location : query
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.list
Description : Lists AnalyzedSessions in a MonitoredAgent.
Path : v1/{+parent}/analyzedSessions
Parameters :
pageToken
Description : Optional. A page token, received from a previous `ListAnalyzedSessions` call.
Location : query
Type : string
parent
Description : Required. The parent MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Required : Yes
Type : string
Location : path
filter
Type : string
Location : query
Description : Optional. Filter expression restricting which AnalyzedSessions are returned. Supports a subset of AIP-160: a closed `detection_time` window (both bounds required), an equality on `severity`, an equality on `agent_type`, and an equality on `session_id`, joined by `AND`. Each clause is optional, may appear at most once, and may appear in any order. The `severity` value is the **canonical** `Severity` enum name -- `SEVERITY_CRITICAL`, `SEVERITY_HIGH`, `SEVERITY_MEDIUM` or `SEVERITY_LOW`. Short forms such as `"CRITICAL"` are rejected, as is `SEVERITY_UNSPECIFIED`. It matches sessions whose *maximum* severity equals that bucket: a session that fires at both LOW and CRITICAL matches `severity = "SEVERITY_CRITICAL"`, not `severity = "SEVERITY_LOW"`. The `agent_type` value is the canonical `AgentResource.AgentType` enum name -- `REASONING_ENGINE`, `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`, `AWS`, `AZURE`, `AGENT_TYPE_OTHER` or `AGENT_TYPE_UNSPECIFIED` -- and matches sessions run by an agent on that runtime. Unlike `severity`, `agent_type` accepts its `UNSPECIFIED` value. The two are not analogous: a session always has a computed severity bucket, so `SEVERITY_UNSPECIFIED` is never returned and filtering on it could only match nothing. `AGENT_TYPE_UNSPECIFIED` *is* returned -- it is what `AnalyzedSession.agent_type` reports for an agent whose runtime was never recorded -- so it must remain filterable. The `session_id` value is a case-sensitive exact match (no substring or prefix matching) on `AnalyzedSession.session_id`. Unlike `severity` and `agent_type` it is not a closed enum, so any non-empty value is accepted; an empty value (`session_id = ""`) is rejected rather than treated as "no filter". Example (time window, severity and runtime): ``` detection_time >= "2024-01-01T00:00:00Z" AND detection_time <= "2024-01-08T00:00:00Z" AND severity = "SEVERITY_CRITICAL" AND agent_type = "CLOUD_RUN_SERVICE" ``` If empty, results are restricted to the last 7 days with no severity, runtime, or session restriction. Other fields, additional operators, set membership (`IN`), and boolean combinations (`OR`, `NOT`, parentheses) are not yet supported.
pageSize
Format : int32
Description : Optional. The maximum number of analyzed sessions to return.
Type : integer
Location : query
view
Description : Optional. Resource view to control which fields are returned.
Location : query
Type : string
Enum :
Enum Descriptions :
orderBy
Location : query
Description : Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append " desc" to a field to sort descending. Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. `latest_detection_time desc` puts the newest sessions first. * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4. `max_severity_rank desc` puts the most-severe sessions first. * `agent_display_name` - the MonitoredAgent's display name. Sorted as a STRING (case-sensitive, code-point order). If empty, defaults to `latest_detection_time desc`. Multi-field sort (for example, `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT.
Type : string
HTTP Method : GET
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.get
HTTP Method : GET
Parameter Order : name
Description : Gets the details of a specific AnalyzedSession.
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The name of the AnalyzedSession resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+$
Type : string
Required : Yes
view
Description : Optional. Resource view to control which fields are returned.
Enum Descriptions :
Type : string
Enum :
Location : query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.aggregate
HTTP Method : GET
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Type : string
Required : Yes
Description : Required. The parent MonitoredAgent resource. Use the `-` wildcard for the monitored_agent segment to aggregate across multiple agents in the location. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Location : path
filter
Location : query
Type : string
Description : Optional. Filter expression restricting which AnalyzedSessions are included in the aggregation. Supports a subset of the `ListAnalyzedSessionsRequest.filter` grammar: a closed `detection_time` window with both bounds required. The `severity` clause is not supported here. If empty, the aggregation covers the last 3 days. Example: ``` detection_time >= "2024-01-01T00:00:00Z" AND detection_time <= "2024-01-08T00:00:00Z" ```
pageSize
Location : query
Description : Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned.
Format : int32
Type : integer
pageToken
Location : query
Description : Optional. The standard list page token.
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions:aggregate
Description : Aggregates AnalyzedSessions across MonitoredAgents. To aggregate across all MonitoredAgents in a location, use the following format for the parent field: `projects/{project}/locations/{location}/monitoredAgents/-`
Path : v1/{+parent}/analyzedSessions:aggregate
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.list
Parameter Order : parent
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Description : Required. The parent AnalyzedSession resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+$
pageToken
Description : Optional. A page token, received from a previous `ListAnalyzedInvocations` call.
Type : string
Location : query
pageSize
Location : query
Type : integer
Description : Optional. The maximum number of analyzed invocations to return.
Format : int32
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}/analyzedInvocations
Path : v1/{+parent}/analyzedInvocations
Description : Lists AnalyzedInvocations in a MonitoredAgent's AnalyzedSession.
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+/analyzedInvocations/[^/]+$
Description : Required. The name of the AnalyzedInvocation resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}/analyzedInvocations/{analyzed_invocation}`
Type : string
Required : Yes
Location : path
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}/analyzedInvocations/{analyzedInvocationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Description : Gets the details of a specific AnalyzedInvocation.
Path : v1/{+name}
▼ ▲ aiplatform.projects.locations.monitoredAgents.list
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/monitoredAgents
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents
HTTP Method : GET
Parameters :
pageSize
Format : int32
Location : query
Description : Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned.
Type : integer
pageToken
Type : string
Description : Optional. The standard list page token.
Location : query
parent
Location : path
Description : Required. The resource name of the Location to list the MonitoredAgents from. Format: `projects/{project}/locations/{location}`
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
filter
Location : query
Type : string
Description : Optional. An AIP-160 filter, currently restricted to a single equality predicate on `state`. The value must be the exact, case-sensitive name of a `MonitoredAgent.EnablementState` value: `ACTIVE`, `DISABLED`, `ENABLING`, or `ENABLEMENT_STATE_UNSPECIFIED`. A blank or absent filter returns every MonitoredAgent in the parent regardless of state; any other value returns `INVALID_ARGUMENT`. Example: ``` state = ACTIVE ```
Description : Lists MonitoredAgents in a specific Location.
▼ ▲ aiplatform.projects.locations.monitoredAgents.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}
Parameter Order : name
HTTP Method : GET
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Location : path
Type : string
Description : Required. The name of the MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Required : Yes
Description : Gets the details of a specific MonitoredAgent.
Path : v1/{+name}
▼ ▲ aiplatform.projects.locations.monitoredAgents.enable
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:enable
Parameters :
name
Description : Required. The name of the MonitoredAgent resource to be enabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Location : path
Type : string
Parameter Order : name
Path : v1/{+name}:enable
HTTP Method : POST
Description : Enables a specific MonitoredAgent.
▼ ▲ aiplatform.projects.locations.monitoredAgents.clearTrainingData
Description : Clears (purges) the trained model artifacts derived from a MonitoredAgent's data. The purged model is rebuilt by the next scheduled training run. To clear every MonitoredAgent in a location's scope, use the `-` wildcard agent segment for the name field: `projects/{project}/locations/{location}/monitoredAgents/-` This is the on-demand data-deletion path for customers who have deleted the underlying logs / observability data a model was trained on. It deletes only the derived model artifacts in the tenant project (it does NOT delete the scope, tenant project, or monitoring). To stop monitoring an agent entirely, disable it via DisableMonitoredAgent. See go/aad-clear-training-data.
Parameter Order : name
Path : v1/{+name}:clearTrainingData
Parameters :
name
Type : string
Description : Required. The MonitoredAgent whose trained model artifacts to purge. Use the `-` wildcard agent segment to purge every MonitoredAgent in the scope. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Location : path
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:clearTrainingData
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.monitoredAgents.disable
Description : Disables a specific MonitoredAgent.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:disable
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The name of the MonitoredAgent resource to be disabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
HTTP Method : POST
Path : v1/{+name}:disable
▼ ▲ aiplatform.projects.locations.agents.search
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agents:search
Scopes :
Parameters :
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous AgentService.SearchAgents call.
pageSize
Description : Optional. The maximum number of agents to return. The maximum page size is 100.
Format : int32
Type : integer
Location : query
orderBy
Location : query
Type : string
Description : Optional. A comma-separated list of fields to order by, such as `created desc`.
parent
Type : string
Description : Required. The resource name of the location to search agents in. Format: `projects/{project}/locations/{location}`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
filter
Type : string
Location : query
Description : Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents.
HTTP Method : GET
Description : Searches the agents in a location that the caller has access to.
Path : v1/{+parent}/agents:search
Parameter Order : parent