Parameter Manager API (parametermanager:v1)

2025-07-08

13 new methods | New API

Additions

    Methods
  • parametermanager.projects.locations.list

      Path : v1/{+name}/locations

      Flat Path : v1/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. A list of extra location types that should be used as conditions for controlling the visibility of the locations.

          Location : query

          Repeated : Yes

          Type : string

      Parameter Order : name

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

      Description : Lists information about the supported locations for this service.

  • parametermanager.projects.locations.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Resource name for the location.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets information about a location.

  • parametermanager.projects.locations.parameters.list

      Path : v1/{+parent}/parameters

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. Parent value for ListParametersRequest in the format `projects/*/locations/*`.

          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/cloud-platform

      Description : Lists Parameters in a given project and location.

  • parametermanager.projects.locations.parameters.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. Name of the resource in the format `projects/*/locations/*/parameters/*`.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets details of a single Parameter.

  • parametermanager.projects.locations.parameters.create

      Path : v1/{+parent}/parameters

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. Value for parent in the format `projects/*/locations/*`.

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

          Location : path

          Required : Yes

          Type : string

        parameterId

          Description : Required. Id of the Parameter resource

          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/cloud-platform

      Description : Creates a new Parameter in a given project and location.

  • parametermanager.projects.locations.parameters.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`.

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Field mask is used to specify the fields to be overwritten in the Parameter resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable 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/cloud-platform

      Description : Updates a single Parameter.

  • parametermanager.projects.locations.parameters.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. Name of the resource in the format `projects/*/locations/*/parameters/*`.

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

          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/cloud-platform

      Description : Deletes a single Parameter.

  • parametermanager.projects.locations.parameters.versions.list

      Path : v1/{+parent}/versions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}/versions

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. Parent value for ListParameterVersionsRequest in the format `projects/*/locations/*/parameters/*`.

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

          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/cloud-platform

      Description : Lists ParameterVersions in a given project, location, and parameter.

  • parametermanager.projects.locations.parameters.versions.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}/versions/{versionsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. Name of the resource in the format `projects/*/locations/*/parameters/*/versions/*`.

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

          Location : path

          Required : Yes

          Type : string

        view

          Description : Optional. View of the ParameterVersion. In the default FULL view, all metadata & payload associated with the ParameterVersion will be returned.

          Location : query

          Type : string

          Enum Descriptions :

        • The default / unset value. The API will default to the FULL view..
        • Include only the metadata for the resource.
        • Include metadata & other relevant payload data as well. This is the default view.
        • Enum :

        • VIEW_UNSPECIFIED
        • BASIC
        • FULL

      Parameter Order : name

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

      Description : Gets details of a single ParameterVersion.

  • parametermanager.projects.locations.parameters.versions.render

      Path : v1/{+name}:render

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}/versions/{versionsId}:render

      HTTP Method : GET

      Parameters :

        name

          Description : Required. Name of the resource

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets rendered version of a ParameterVersion.

  • parametermanager.projects.locations.parameters.versions.create

      Path : v1/{+parent}/versions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}/versions

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. Value for parent in the format `projects/*/locations/*/parameters/*`.

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

          Location : path

          Required : Yes

          Type : string

        parameterVersionId

          Description : Required. Id of the ParameterVersion resource

          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/cloud-platform

      Description : Creates a new ParameterVersion in a given project, location, and parameter.

  • parametermanager.projects.locations.parameters.versions.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}/versions/{versionsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Field mask is used to specify the fields to be overwritten in the ParameterVersion resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable 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/cloud-platform

      Description : Updates a single ParameterVersion.

  • parametermanager.projects.locations.parameters.versions.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}/versions/{versionsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. Name of the resource in the format `projects/*/locations/*/parameters/*/versions/*`.

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

          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/cloud-platform

      Description : Deletes a single ParameterVersion.