2022-02-03
▼ ▲ certificatemanager.projects.locations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists information about the supported locations for this service.
Parameter Order: name
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+$
Required: Yes
Description: The resource that owns the locations collection, if applicable.
pageSize
Type: integer
Format: int32
Description: The maximum number of results to return. If not set, the service selects a default.
Location: query
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
filter
Location: query
Type: string
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).
HTTP Method: GET
Path: v1/{+name}/locations
Flat Path: v1/projects/{projectsId}/locations
▼ ▲ certificatemanager.projects.locations.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: Resource name for the location.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Parameter Order: name
Path: v1/{+name}
Description: Gets information about a location.
▼ ▲ certificatemanager.projects.locations.dnsAuthorizations.get
Description: Gets details of a single DnsAuthorization.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations/{dnsAuthorizationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dnsAuthorizations/[^/]+$
Location: path
Type: string
Description: Required. A name of the dns authorization to describe. Must be in the format `projects/*/locations/*/dnsAuthorizations/*`.
Parameter Order: name
HTTP Method: GET
▼ ▲ certificatemanager.projects.locations.dnsAuthorizations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single DnsAuthorization.
HTTP Method: DELETE
Parameters:
name
Description: Required. A name of the dns authorization to delete. Must be in the format `projects/*/locations/*/dnsAuthorizations/*`.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dnsAuthorizations/[^/]+$
Type: string
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations/{dnsAuthorizationsId}
▼ ▲ certificatemanager.projects.locations.dnsAuthorizations.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Location: query
Type: string
Description: Filter expression to restrict the Dns Authorizations returned.
pageToken
Type: string
Location: query
Description: The value returned by the last `ListDnsAuthorizationsResponse`. Indicates that this is a continuation of a prior `ListDnsAuthorizations` call, and that the system should return the next page of data.
pageSize
Location: query
Description: Maximum number of dns authorizations to return per call.
Type: integer
Format: int32
parent
Description: Required. The project and location from which the dns authorizations should be listed, specified in the format `projects/*/locations/*`.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
orderBy
Description: A list of Dns Authorization field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
Location: query
Type: string
Path: v1/{+parent}/dnsAuthorizations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations
Description: Lists DnsAuthorizations in a given project and location.
Parameter Order: parent
▼ ▲ certificatemanager.projects.locations.dnsAuthorizations.patch
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a DnsAuthorization.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations/{dnsAuthorizationsId}
HTTP Method: PATCH
Parameters:
name
Description: A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dnsAuthorizations/[^/]+$
Required: Yes
updateMask
Location: query
Description: Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
Format: google-fieldmask
Type: string
▼ ▲ certificatemanager.projects.locations.dnsAuthorizations.create
Parameter Order: parent
Description: Creates a new DnsAuthorization in a given project and location.
Path: v1/{+parent}/dnsAuthorizations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
dnsAuthorizationId
Description: Required. A user-provided name of the dns authorization.
Location: query
Type: string
parent
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent resource of the dns authorization. Must be in the format `projects/*/locations/*`.
▼ ▲ certificatemanager.projects.locations.certificates.get
HTTP Method: GET
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Required: Yes
Description: Required. A name of the certificate to describe. Must be in the format `projects/*/locations/*/certificates/*`.
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Certificate.
Path: v1/{+name}
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
▼ ▲ certificatemanager.projects.locations.certificates.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificates
HTTP Method: POST
Path: v1/{+parent}/certificates
Description: Creates a new Certificate in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
certificateId
Location: query
Description: Required. A user-provided name of the certificate.
Type: string
parent
Description: Required. The parent resource of the certificate. Must be in the format `projects/*/locations/*`.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Parameter Order: parent
▼ ▲ certificatemanager.projects.locations.certificates.list
Path: v1/{+parent}/certificates
Parameters:
pageSize
Format: int32
Location: query
Description: Maximum number of certificates to return per call.
Type: integer
orderBy
Type: string
Description: A list of Certificate field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
Location: query
parent
Type: string
Description: Required. The project and location from which the certificate should be listed, specified in the format `projects/*/locations/*`.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Type: string
Location: query
Description: The value returned by the last `ListCertificatesResponse`. Indicates that this is a continuation of a prior `ListCertificates` call, and that the system should return the next page of data.
filter
Location: query
Type: string
Description: Filter expression to restrict the Certificates returned.
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificates
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Certificates in a given project and location.
▼ ▲ certificatemanager.projects.locations.certificates.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
Description: Deletes a single Certificate.
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameters:
name
Required: Yes
Type: string
Description: Required. A name of the certificate to delete. Must be in the format `projects/*/locations/*/certificates/*`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
▼ ▲ certificatemanager.projects.locations.certificates.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
Description: Updates a Certificate.
Parameters:
updateMask
Location: query
Type: string
Format: google-fieldmask
Description: Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
name
Location: path
Type: string
Description: A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}
HTTP Method: PATCH
▼ ▲ certificatemanager.projects.locations.certificateMaps.delete
Description: Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. A name of the certificate map to delete. Must be in the format `projects/*/locations/*/certificateMaps/*`.
HTTP Method: DELETE
▼ ▲ certificatemanager.projects.locations.certificateMaps.patch
Parameters:
updateMask
Format: google-fieldmask
Location: query
Description: Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
Type: string
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$
Required: Yes
Description: A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Path: v1/{+name}
Description: Updates a CertificateMap.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}
Parameter Order: name
▼ ▲ certificatemanager.projects.locations.certificateMaps.create
Parameter Order: parent
Description: Creates a new CertificateMap in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/certificateMaps
Parameters:
certificateMapId
Type: string
Location: query
Description: Required. A user-provided name of the certificate map.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The parent resource of the certificate map. Must be in the format `projects/*/locations/*`.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps
HTTP Method: POST
▼ ▲ certificatemanager.projects.locations.certificateMaps.get
HTTP Method: GET
Parameters:
name
Description: Required. A name of the certificate map to describe. Must be in the format `projects/*/locations/*/certificateMaps/*`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$
Location: path
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}
Description: Gets details of a single CertificateMap.
Path: v1/{+name}
▼ ▲ certificatemanager.projects.locations.certificateMaps.list
Parameters:
filter
Description: Filter expression to restrict the Certificates Maps returned.
Location: query
Type: string
pageToken
Location: query
Description: The value returned by the last `ListCertificateMapsResponse`. Indicates that this is a continuation of a prior `ListCertificateMaps` call, and that the system should return the next page of data.
Type: string
orderBy
Type: string
Location: query
Description: A list of Certificate Map field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
parent
Required: Yes
Type: string
Description: Required. The project and location from which the certificate maps should be listed, specified in the format `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
pageSize
Description: Maximum number of certificate maps to return per call.
Location: query
Format: int32
Type: integer
Path: v1/{+parent}/certificateMaps
Parameter Order: parent
Description: Lists CertificateMaps in a given project and location.
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps
▼ ▲ certificatemanager.projects.locations.certificateMaps.certificateMapEntries.create
Path: v1/{+parent}/certificateMapEntries
HTTP Method: POST
Description: Creates a new CertificateMapEntry in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
certificateMapEntryId
Description: Required. A user-provided name of the certificate map entry.
Type: string
Location: query
parent
Description: Required. The parent resource of the certificate map entry. Must be in the format `projects/*/locations/*/certificateMaps/*`.
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries
▼ ▲ certificatemanager.projects.locations.certificateMaps.certificateMapEntries.delete
Path: v1/{+name}
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries/{certificateMapEntriesId}
Description: Deletes a single CertificateMapEntry.
Parameter Order: name
Parameters:
name
Description: Required. A name of the certificate map entry to delete. Must be in the format `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+/certificateMapEntries/[^/]+$
▼ ▲ certificatemanager.projects.locations.certificateMaps.certificateMapEntries.list
Path: v1/{+parent}/certificateMapEntries
HTTP Method: GET
Parameter Order: parent
Parameters:
pageToken
Type: string
Description: The value returned by the last `ListCertificateMapEntriesResponse`. Indicates that this is a continuation of a prior `ListCertificateMapEntries` call, and that the system should return the next page of data.
Location: query
filter
Description: Filter expression to restrict the returned Certificate Map Entries.
Type: string
Location: query
orderBy
Location: query
Type: string
Description: A list of Certificate Map Entry field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
pageSize
Description: Maximum number of certificate map entries to return. The service may return fewer than this value. If unspecified, at most 50 certificate map entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Type: integer
Format: int32
Location: query
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$
Description: Required. The project, location and certificate map from which the certificate map entries should be listed, specified in the format `projects/*/locations/*/certificateMaps/*`.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries
Description: Lists CertificateMapEntries in a given project and location.
▼ ▲ certificatemanager.projects.locations.certificateMaps.certificateMapEntries.patch
HTTP Method: PATCH
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries/{certificateMapEntriesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a CertificateMapEntry.
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+/certificateMapEntries/[^/]+$
Type: string
Location: path
Description: A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.
updateMask
Format: google-fieldmask
Description: Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
Location: query
Type: string
▼ ▲ certificatemanager.projects.locations.certificateMaps.certificateMapEntries.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+/certificateMapEntries/[^/]+$
Type: string
Description: Required. A name of the certificate map entry to describe. Must be in the format `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.
Required: Yes
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries/{certificateMapEntriesId}
Description: Gets details of a single CertificateMapEntry.
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
▼ ▲ certificatemanager.projects.locations.operations.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameter Order: name
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.
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource.
Path: v1/{+name}
▼ ▲ certificatemanager.projects.locations.operations.cancel
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`.
Path: v1/{+name}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Required: Yes
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method: POST
▼ ▲ certificatemanager.projects.locations.operations.delete
Parameters:
name
Description: The name of the operation resource to be deleted.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Location: path
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: DELETE
Parameter Order: name
Scopes: 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`.
▼ ▲ certificatemanager.projects.locations.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters:
pageToken
Location: query
Description: The standard list page token.
Type: string
filter
Type: string
Location: query
Description: The standard list filter.
pageSize
Type: integer
Location: query
Description: The standard list page size.
Format: int32
name
Location: path
Type: string
Required: Yes
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
Path: v1/{+name}/operations
HTTP Method: GET