Agent Registry API (agentregistry:v1alpha)

2026-03-19

17 new methods | New API

Additions

    Methods
  • agentregistry.projects.locations.list

      Path : v1alpha/{+name}/locations

      Flat Path : v1alpha/projects/{projectsId}/locations

      HTTP Method : GET

      Parameters :

        name

          Description : The resource that owns the locations collection, if applicable.

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

          Location : query

          Type : string

        pageSize

          Description : The maximum number of results to return. If not set, the service selects a default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Location : query

          Type : string

        extraLocationTypes

          Description : Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

          Location : query

          Repeated : Yes

          Type : string

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

  • agentregistry.projects.locations.get

  • agentregistry.projects.locations.operations.list

      Path : v1alpha/{+name}/operations

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation's parent resource.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

        returnPartialSuccess

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Location : query

          Type : boolean

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • agentregistry.projects.locations.operations.get

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • agentregistry.projects.locations.operations.delete

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : The name of the operation resource to be deleted.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

  • agentregistry.projects.locations.operations.cancel

      Path : v1alpha/{+name}:cancel

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameters :

        name

          Description : The name of the operation resource to be cancelled.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

  • agentregistry.projects.locations.agents.list

      Path : v1alpha/{+parent}/agents

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/agents

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. Parent value for ListAgentsRequest

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A token identifying a page of results the server should return.

          Location : query

          Type : string

        filter

          Description : Optional. Filtering results

          Location : query

          Type : string

        orderBy

          Description : Optional. Hint for how to order the results

          Location : query

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-only
    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Lists Agents in a given project and location.

  • agentregistry.projects.locations.agents.get

  • agentregistry.projects.locations.endpoints.list

      Path : v1alpha/{+parent}/endpoints

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/endpoints

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The project and location to list endpoints in. Expected format: `projects/{project}/locations/{location}`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A token identifying a page of results the server should return.

          Location : query

          Type : string

        filter

          Description : Optional. A query string used to filter the list of endpoints returned. The filter expression must follow AIP-160 syntax. Filtering is supported on the `name`, `display_name`, `description`, `version`, and `interfaces` fields. Some examples: * `name = "projects/p1/locations/l1/endpoints/e1"` * `display_name = "my-endpoint"` * `description = "my-endpoint-description"` * `version = "v1"` * `interfaces.transport = "HTTP_JSON"`

          Location : query

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-only
    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Lists Endpoints in a given project and location.

  • agentregistry.projects.locations.endpoints.get

  • agentregistry.projects.locations.mcpServers.list

      Path : v1alpha/{+parent}/mcpServers

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/mcpServers

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. Parent value for ListMcpServersRequest. Format: `projects/{project}/locations/{location}`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A token identifying a page of results the server should return.

          Location : query

          Type : string

        filter

          Description : Optional. Filtering results

          Location : query

          Type : string

        orderBy

          Description : Optional. Hint for how to order the results

          Location : query

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-only
    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Lists McpServers in a given project and location.

  • agentregistry.projects.locations.mcpServers.get

  • agentregistry.projects.locations.services.list

      Path : v1alpha/{+parent}/services

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/services

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The project and location to list services in. Expected format: `projects/{project}/locations/{location}`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A token identifying a page of results the server should return.

          Location : query

          Type : string

        filter

          Description : Optional. A query string used to filter the list of services returned. The filter expression must follow AIP-160 syntax. Filtering is supported on the `name`, `display_name`, `description`, and `labels` fields. Some examples: * `name = "projects/p1/locations/l1/services/s1"` * `display_name = "my-service"` * `description : "myservice description"` * `labels.env = "prod"`

          Location : query

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-only
    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Lists Services in a given project and location.

  • agentregistry.projects.locations.services.get

  • agentregistry.projects.locations.services.create

      Path : v1alpha/{+parent}/services

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/services

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The project and location to create the Service in. Expected format: `projects/{project}/locations/{location}`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        serviceId

          Description : Required. The ID to use for the service, which will become the final component of the service's resource name. This value should be 4-63 characters, and valid characters are `/a-z-/`.

          Location : query

          Type : string

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Creates a new Service in a given project and location.

  • agentregistry.projects.locations.services.patch

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.

          Location : query

          Type : string

          Format : google-fieldmask

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Updates the parameters of a single Service.

  • agentregistry.projects.locations.services.delete

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location : path

          Required : Yes

          Type : string

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/agentregistry.read-write
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Deletes a single Service.