Retire

Retire

Use this endpoint to Retire template
Authorized Roles : PROVIDER

Request
URI
PUT
https://{api_host}/provider/templates/{id}/retire
COPY
Path Parameters
string
id
Required

ID of the template

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProviderTemplate of type(s) application/vnd.vmware.dms-v1+json 
{
    "logicalBuildId": "string",
    "version": "string",
    "databaseType": "string",
    "latestShellOvaVersion": "string",
    "latestCoreRpmVersion": "string",
    "latestAdapterRpmVersion": "string",
    "latestDbengineRpmVersion": "string",
    "systemDefaults": {
        "cpu": {
            "min": 0,
            "max": 0,
            "defaultCPU": 0
        },
        "memory": {
            "min": 0,
            "max": 0,
            "defaultMemory": 0,
            "unit": "string"
        },
        "disk": {
            "min": 0,
            "max": 0,
            "defaultDisk": 0,
            "unit": "string"
        }
    },
    "dbOptions": [
        {
            "key": "string",
            "value": "string",
            "type": "string",
            "url": "string"
        }
    ],
    "deleted": false,
    "templateStatus": "string",
    "templateType": "string",
    "lastProcessedTime": "string",
    "maxReadReplica": 0,
    "edition": "string",
    "parentLogicalBuildId": "string"
}
string As uuid As uuid
logicalBuildId
Optional

logicalBuildId

string
version
Optional

version

string
databaseType
Optional

databaseType

string
latestShellOvaVersion
Optional

latestShellOvaVersion

string
latestCoreRpmVersion
Optional

latestCoreRpmVersion

string
latestAdapterRpmVersion
Optional

latestAdapterRpmVersion

string
latestDbengineRpmVersion
Optional

latestDbengineRpmVersion

object
shellOvaUpdates
Optional

shellOvaUpdates

object
coreRpmUpdates
Optional

coreRpmUpdates

object
adapterRpmUpdates
Optional

adapterRpmUpdates

object
dbEngineRpmUpdates
Optional

dbEngineRpmUpdates

SystemDefaults
systemDefaults
Optional

systemDefaults

array of DbOption
dbOptions
Optional

dbOptions

boolean
deleted
Optional

deleted

string
templateStatus
Optional

templateStatus

Possible values are : PUBLISHED, UNPUBLISHED, RETIRED, REQUESTED, INPROGRESS, FAILED, AVAILABLE, NOT_AVAILABLE, UPLOAD_REQUIRED, UPLOADING,
string
templateType
Optional

templateType

Possible values are : PREDEFINED, PROVIDER_UPLOADED, ORG_ADMIN_UPLOADED,
string As date-time As date-time
lastProcessedTime
Optional

lastProcessedTime

integer As int32 As int32
maxReadReplica
Optional

maxReadReplica

string
edition
Optional

edition

string As uuid As uuid
parentLogicalBuildId
Optional

parentLogicalBuildId


400

Bad Request

Operation doesn't return any data structure

On This Page
Templates Operations
POST
Create Editions By Uploading DB Engine
GET
Find BYOI Templates
GET
Find Distinct Database Types
GET
Get Db Type Versions
GET
Get Page
GET
Get Template
PUT
Publish
PUT
Retire
PUT
Unpublish
PUT
Update Or Upload DB Engine