HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
HashiCorp Cloud Platform
HashiCorp Cloud Platform

RestoreSnapshot

post

/clusters/{cluster_id}/restore

RestoreSnapshot

https://api.cloud.hashicorp.com/vault/2020-11-25/organizations/{location.organization_id}/projects/{location.project_id}/clusters/{cluster_id}/restore

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

cluster_idstringRequired
Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • organization_idstring

    organization_id is the id of the organization.

  • project_idstring

    project_id is the projects id.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
cluster_idstring
snapshot_idstring

Response

200 - OK
operationobject

Operation represents a single operation.

  • idstring

    id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

    You can find out more about this error model and how to work with it in the API Design Guide.

    • codeinteger

      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    • messagestring

      A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • type_urlstring

        A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

        In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

        • If no scheme is provided, https is assumed.
        • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
        • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

        Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

        Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

      • valuestring

        Must be a valid serialized protocol buffer of the above specified type.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • type_urlstring

      A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

      In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

      • If no scheme is provided, https is assumed.
      • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
      • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

      Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

      Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

    • valuestring

      Must be a valid serialized protocol buffer of the above specified type.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

      description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

  • created_atstring

    CreatedAt is the timestamp of when the operation was first created.

  • updated_atstring

    UpdatedAt is the timestamp of when the operation was last updated.

Default Error Response
errorstring
codeinteger
messagestring
detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • type_urlstring

    A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

    In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

    • If no scheme is provided, https is assumed.
    • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
    • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

    Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

    Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • valuestring

    Must be a valid serialized protocol buffer of the above specified type.