Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-134796204.9 KB
projects

Creates a new SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance.

post/v1/{+parent}/proposals

Path parameters

parentstring required

Required. The name of the SingleTenantHsmInstance associated with the SingleTenantHsmInstanceProposals.

Query parameters

singleTenantHsmInstanceProposalIdstring

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

Request body

deleteTimestring google-datetime

Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.

disableSingleTenantHsmInstanceDisableSingleTenantHsmInstance

Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

refreshSingleTenantHsmInstanceRefreshSingleTenantHsmInstance

Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

enableSingleTenantHsmInstanceEnableSingleTenantHsmInstance

Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.

deleteSingleTenantHsmInstanceDeleteSingleTenantHsmInstance

Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must not be in the DELETING or DELETED state to perform this operation.

state'STATE_UNSPECIFIED' | 'CREATING' | 'PENDING' | 'APPROVED' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'DELETED'

Output only. The state of the SingleTenantHsmInstanceProposal.

failureReasonstring

Output only. The root cause of the most recent failure. Only present if state is FAILED.

expireTimestring google-datetime

The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.

namestring

Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.

ttlstring google-duration

Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

purgeTimestring google-datetime

Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).

createTimestring google-datetime

Output only. The time at which the SingleTenantHsmInstanceProposal was created.

Response

Successful response