Struct RestoreKeyRequest

pub struct RestoreKeyRequest {
    pub mount: String,
    pub backup: String,
    pub name: Option<String>,
    pub force: Option<bool>,
}

Restore Key

This endpoint restores the backup as a named key. This will restore the key configurations and all the versions of the named key along with HMAC keys. The input to this endpoint should be the output of /backup endpoint.

• Path: {self.mount}/restore(/{self.name})
• Method: POST
• Response: N/A
• Reference: https://developer.hashicorp.com/vault/api-docs/secret/transit#restore-key

Fields

mount: String

backup: String

Backed up key data to be restored. This should be the output from the /backup endpoint.

name: Option<String>

If set, this will be the name of the restored key.

force: Option<bool>

If set, force the restore to proceed even if a key by this name already exists.

Implementations

impl RestoreKeyRequest

pub fn builder() -> RestoreKeyRequestBuilder

Trait Implementations

impl Debug for RestoreKeyRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RestoreKeyRequest

fn default() -> RestoreKeyRequest

Returns the “default value” for a type.

impl Endpoint for RestoreKeyRequest

const REQUEST_BODY_TYPE: RequestType = RequestType::JSON

The content type of the request body

const RESPONSE_BODY_TYPE: ResponseType = ResponseType::JSON

The content type of the response body

type Response = ()

The type that the raw response from executing this endpoint will deserialized into. This type is passed on to the EndpointResult and is used to determine the type returned when the parse() method is called.

fn path(&self) -> String

The relative URL path that represents the location of this Endpoint. This is combined with the base URL from a Client instance to create the fully qualified URL.

fn method(&self) -> RequestMethod

The HTTP method to be used when executing this Endpoint.

fn body(&self) -> Result<Option<Vec<u8>>, ClientError>

Optional data to add to the body of the request.

fn query(&self) -> Result<Option<String>, ClientError>

Optional query parameters to add to the request.

fn url(&self, base: &str) -> Result<Uri, ClientError>

Returns the full URL address of the endpoint using the base address.

fn request(&self, base: &str) -> Result<Request<Vec<u8>>, ClientError>

Returns a Request containing all data necessary to execute against this endpoint.

fn exec<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 (impl Client + 'async_trait), ) -> Pin<Box<dyn Future<Output = Result<EndpointResult<Self::Response>, ClientError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Executes the Endpoint using the given Client.

fn with_middleware<M>(self, middleware: &M) -> MutatedEndpoint<'_, Self, M>

where M: MiddleWare,