Prevalidate Product Snapshot Request Using POST

Prevalidate Product Snapshot Request Using POST

This API is used to trigger a product snapshot pre-validation request.

Request
URI
POST
https://{api_host}/lcm/lcops/api/environments/{environmentId}/products/{productId}/snapshot/inventory/prevalidate
COPY
Path Parameters
string
environmentId
Required

environmentId

string
productId
Required

productId

Query Parameters
string
tenantId
Optional

tenantId

Request Body
SnapshotInventoryRequestDTO of type(s) application/json
Optional 
{
    "description": "description",
    "shutdownBeforeSnapshot": false,
    "snapshotPrefix": "vra_snapshot1",
    "snapshotWithMemory": false
}
string
description
Optional

Snapshot description

boolean
shutdownBeforeSnapshot
Optional

Shutdown machines before snapshot

string
snapshotPrefix
Optional

Snapshot Prefix

boolean
snapshotWithMemory
Optional

Snapshot with Memory

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GenericRequestResponse of type(s) application/json 
{
    "requestId": "a0d8d8cd-ac87-4b5c-ba8b-7a0173c56b55"
}
string
requestId
Optional

Request ID


201

Created

Operation doesn't return any data structure

400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

409

Conflict

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


On This Page
Snapshot Inventory Controller Operations
POST
Create Snapshot Using POST
DELETE
Delete Product Snapshot Using DELETE
GET
Get All Product Snapshots Using GET
POST
Prevalidate Product Snapshot Request Using POST
POST
Prevalidate Product Snapshot Revert Request Using POST
POST
Revert Product Snapshot Request Using POST