2026-08-30
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.authorizeAccess
Description : Checks whether the caller is authorized to access the sandbox environment. Authorization is performed entirely by the API infrastructure from the `method_policy` below; the handler is a no-op. A successful response means the caller holds `sandboxEnvironments.execute` on the named sandbox. Used by the sandbox data-plane proxy, which forwards the caller's credential and proxies traffic only on success.
Path : v1beta1/{+name}:authorizeAccess
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameters :
name
Type : string
Location : path
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Description : Required. The resource name of the sandbox environment to authorize access to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Required : Yes
Parameter Order : name
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:authorizeAccess
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.authorizeAccess
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}:authorizeAccess
HTTP Method : POST
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Location : path
Type : string
Description : Required. The resource name of the sandbox environment to authorize access to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:authorizeAccess
Parameter Order : name
Description : Checks whether the caller is authorized to access the sandbox environment. Authorization is performed entirely by the API infrastructure from the `method_policy` below; the handler is a no-op. A successful response means the caller holds `sandboxEnvironments.execute` on the named sandbox. Used by the sandbox data-plane proxy, which forwards the caller's credential and proxies traffic only on success.
▼ ▲ aiplatform.projects.locations.agents.testIamPermissions
HTTP Method : POST
Parameters :
permissions
Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Location : query
Repeated : Yes
Type : string
resource
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Parameter Order : resource
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+resource}:testIamPermissions
▼ ▲ aiplatform.projects.locations.agents.getIamPolicy
Parameter Order : resource
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:getIamPolicy
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+resource}:getIamPolicy
HTTP Method : POST
Parameters :
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type : integer
Format : int32
Location : query
resource
Location : path
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
▼ ▲ aiplatform.projects.locations.agents.setIamPolicy
HTTP Method : POST
Parameters :
resource
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Parameter Order : resource
Path : v1beta1/{+resource}:setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:setIamPolicy
▼ ▲ aiplatform.projects.locations.agents.list
Parameters :
filter
Location : query
Type : string
Description : Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields: * `created` * `updated` Both are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `<`, `>`, `<=`, `>=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. Example: `created > "2026-08-01T00:00:00Z" AND updated < "2026-08-09T00:00:00Z"`. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`.
▼ ▲ aiplatform.projects.locations.agents.delete
Parameters :
force
Location : query
Type : boolean
Description : Optional. If true, any `Task` belonging to this agent is deleted along with it. If false or unset and the agent still has at least one `Task`, the request fails with `FAILED_PRECONDITION` and nothing is deleted. This governs `Task` and nothing else. Resources the agent owns but a caller never named -- its AI Application and the tenant project bound to it, its Workspace identity, its service-extension binding -- are torn down with the agent on every delete, whatever this field says.