2026-08-30
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.authorizeAccess
Path : v1/{+name}:authorizeAccess
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}: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.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The resource name of the sandbox environment to authorize access to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Parameter Order : name
▼ ▲ aiplatform.projects.locations.agents.getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+resource}:getIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:getIamPolicy
Parameter Order : resource
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
HTTP Method : POST
Parameters :
resource
Location : path
Type : string
Required : Yes
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.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
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).
Location : query
Format : int32
Type : integer
▼ ▲ aiplatform.projects.locations.agents.testIamPermissions
HTTP Method : POST
Parameters :
resource
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.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
permissions
Location : query
Repeated : Yes
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).
Type : string
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:testIamPermissions
Path : v1/{+resource}:testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.agents.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.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:setIamPolicy
Parameters :
resource
Type : string
Required : Yes
Location : path
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.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.authorizeAccess
Path : v1/{+name}:authorizeAccess
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:authorizeAccess
HTTP Method : POST
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.
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Location : path
Description : Required. The resource name of the sandbox environment to authorize access to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
▼ ▲ aiplatform.projects.locations.agents.delete
Parameters :
force
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.
Location : query
▼ ▲ aiplatform.projects.locations.agents.list
Parameters :
filter
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`.
Type : string
Location : query