Create App

Creates a new App in the provided organization. If appType is ContainerApp, and field kubernetes.paused is set to false, this API returns 202 with task URL in location header. If appType is ContainerApp, and field kubernetes.paused is set to false, this API returns 201 with the paused ContainerApp in response body. If appType is VmApp, then this method throws 400 BadRequest exception. VM based apps cannot be created using this API. Returns 400 if an app with the same name already exists.

Request

URI

POST

https://{api_host}/cloudapi/1.0.0/apps

COPY

Request Body

App of type(s) application/json

Optional

{
    "appType": "string",
    "id": "string",
    "appTemplateId": "string",
    "appId": "string",
    "appVersion": "string",
    "name": "string",
    "description": "string",
    "creationDate": "string",
    "status": "READY, FAILED, NOT_READY",
    "logoUrl": "string",
    "screenshotUrls": [
        "string"
    ],
    "owner": {
        "name": "string",
        "id": "string"
    },
    "org": {
        "name": "string",
        "id": "string"
    },
    "vdc": {
        "name": "string",
        "id": "string"
    },
    "eulaAccepted": false
}

string

appType

Required

Type of application. This is a discriminator field that helps in distinguishing the type of app this object represents. If the app is running in Kubernetes cluster, the value of this field is ContainerApp. If the app is running in a virtual machine or a collection of virtual machines then this the value of this field is VmApp.

string

Optional

A unique identifier for the app.

string

appTemplateId

Optional

An identifier to the appTemplate from which this app is created.

string

appId

Required

An identifier by which this application is uniquely identified in its source catalog.

string

appVersion

Required

Version of this application.

string

name

Required

The name of the app. If the app is ContainerApp, the value of this field must consist of lowercase alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character.

string

description

Optional

The description of the app.

string As date-time As date-time

creationDate

Optional

The date and time when this app was created. This value will be formatted as per ISO 8601 format and include timezone information.

string

status

Optional

Status indicating whether this app is ready or not.

string

logoUrl

Optional

URL of the logo of this application.

array of string

screenshotUrls

Optional

List of screenshot URLs of the App.

EntityReference

owner

Optional

Entity reference used to describe VCD entities

EntityReference

org

Required

Entity reference used to describe VCD entities

EntityReference

vdc

Optional

Entity reference used to describe VCD entities

boolean

eulaAccepted

Optional

Accepts EULA for the application version this App is launched from. If one application is protected by EULA, app creation, upgrade and downgrade requires to accept the EULA for the target application version.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

201

Created

Returns App of type(s) */*;version=39.0

{
    "appType": "string",
    "id": "string",
    "appTemplateId": "string",
    "appId": "string",
    "appVersion": "string",
    "name": "string",
    "description": "string",
    "creationDate": "string",
    "status": "READY, FAILED, NOT_READY",
    "logoUrl": "string",
    "screenshotUrls": [
        "string"
    ],
    "owner": {
        "name": "string",
        "id": "string"
    },
    "org": {
        "name": "string",
        "id": "string"
    },
    "vdc": {
        "name": "string",
        "id": "string"
    },
    "eulaAccepted": false
}

string

appType

Required

string

Optional

A unique identifier for the app.

string

appTemplateId

Optional

An identifier to the appTemplate from which this app is created.

string

appId