Save Manifest

Save Manifest

Save/Load manifest. Make sure manifest is a valid one. If manifest already exists, it gets overridden.

Request
URI
POST
https://{api_host}/v1/manifests
COPY
Request Body
Manifest of type(s) application/json
Required

Show optional properties

{
    "version": 0,
    "sequenceNumber": 0,
    "creationTime": "string",
    "publishedDate": "string",
    "releases": [
        {
            "product": "string",
            "version": "string",
            "minCompatibleVcfVersion": "string",
            "description": "string",
            "releaseDate": "string",
            "bom": [
                {
                    "name": "string",
                    "version": "string",
                    "publicName": "string"
                }
            ]
        }
    ]
}
{
    "version": 0,
    "sequenceNumber": 0,
    "creationTime": "string",
    "publishedDate": "string",
    "releases": [
        {
            "product": "string",
            "version": "string",
            "minCompatibleVcfVersion": "string",
            "description": "string",
            "releaseDate": "string",
            "bom": [
                {
                    "name": "string",
                    "version": "string",
                    "publicName": "string",
                    "releaseURL": "string",
                    "additionalMetadata": "string"
                }
            ],
            "isApplicable": false,
            "notApplicableReason": "string",
            "sku": [
                {
                    "name": "string",
                    "description": "string",
                    "skuSpecificPatchBundles": [
                        {
                            "bundleType": "string",
                            "bundleVersion": "string",
                            "version": "string"
                        }
                    ],
                    "bom": [
                        {
                            "name": "string",
                            "version": "string",
                            "publicName": "string",
                            "releaseURL": "string",
                            "additionalMetadata": "string"
                        }
                    ]
                }
            ],
            "updates": [
                {
                    "id": "string",
                    "productName": "string",
                    "baseProductVersion": "string",
                    "description": "string",
                    "releaseUpdateURL": "string",
                    "releaseDate": "string"
                }
            ],
            "patchBundles": [
                {
                    "bundleId": "string",
                    "bundleType": "string",
                    "bundleElements": [
                        "string"
                    ],
                    "cumulativeFromVcfVersion": "string"
                }
            ],
            "eol": "string",
            "upgradeOrder": "string"
        }
    ],
    "recalledBundles": [
        {
            "recalledBundleIds": [
                "string"
            ],
            "replacementBundleStatus": "One among: NONE, PENDING, READY",
            "replacementBundleIds": [
                "string"
            ]
        }
    ],
    "sddcManagerReleases": [
        {
            "version": "string",
            "description": "string",
            "additionalMetadata": "string",
            "bundleId": "string",
            "releaseDate": 0,
            "cumulativeFromVcfVersion": "string"
        }
    ],
    "asyncPatches": {
        "asyncPatches": [
            {
                "productVersion": "string",
                "supportedSkuTypes": [
                    "One among: VXRAIL, VSAN"
                ],
                "inputSpecUrl": "string",
                "sddcHotPatchInfo": {
                    "sddcHotPatchInfo": [
                        {
                            "version": "string",
                            "sddcHotPatchMinTargetVcfVersion": "string"
                        }
                    ]
                }
            }
        ]
    },
    "vvsMappings": {
        "vvsMappings": {
            "vvsMappings": {
                "version": "string",
                "aliases": [
                    "string"
                ]
            }
        }
    }
}
integer As int32 As int32
version
Required

Manifest version supported by VCF

integer As int32 As int32
sequenceNumber
Required

Manifest sequence number which signifies an update in manifest

string
creationTime
Required

Creation time for the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format

string
publishedDate
Required

Date of publish of the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format

array of Release
releases
Required

Releases of VCF in the ascending order of product version

array of BundleRecall
recalledBundles
Optional

Collection of bundles that are recalled and their replacements, if applicable

array of SddcManagerRelease
sddcManagerReleases
Optional

Product releases in the ascending order of product version

object
asyncPatches
Optional

Async patches used by Async Patch Tool

object
vvsMappings
Optional

VVS product release Id to VCF version mapping

Responses
202

Accepted

Operation doesn't return any data structure

400

Bad Request

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of ErrorCause
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


On This Page
Manifests Operations
GET
Get Manifest
POST
Save Manifest