app.convert_to_custom

Convert app_name to a custom app.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: app_name

app_name

Type: string

Must be at least 1 characters long

Return value

AppEntry

Type: object
No Additional Properties

name Required

Name

Type: string

Must be at least 1 characters long

id Required

Id

Type: string

Must be at least 1 characters long

state Required

State

Type: enum (of string)

Must be one of:

• "CRASHED"
• "DEPLOYING"
• "RUNNING"
• "STOPPED"
• "STOPPING"

upgrade_available Required

Upgrade Available

Type: boolean

latest_version Required

Latest Version

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

image_updates_available Required

Image Updates Available

Type: boolean

custom_app Required

Custom App

Type: boolean

migrated Required

Migrated

Type: boolean

human_version Required

Human Version

Type: string

Must be at least 1 characters long

version Required

Version

Type: string

Must be at least 1 characters long

metadata Required

Metadata

Type: object

active_workloads Required

AppActiveWorkloads

Type: object
No Additional Properties

containers Required

Containers

Type: integer

used_ports Required

Used Ports

Type: array of object
No Additional Items

Each item of this array must be:

UsedPorts

Type: object
No Additional Properties

container_port Required

Container Port

Type: integer

protocol Required

Protocol

Type: string

host_ports Required

Host Ports

Type: array of object
No Additional Items

Each item of this array must be:

HostPorts

Type: object
No Additional Properties

host_port Required

Host Port

Type: integer

host_ip Required

Host Ip

Type: string

container_details Required

Container Details

Type: array of object
No Additional Items

Each item of this array must be:

AppContainerDetails

Type: object
No Additional Properties

id Required

Id

Type: string

service_name Required

Service Name

Type: string

image Required

Image

Type: string

port_config Required

Port Config

Type: array of object
No Additional Items

Each item of this array must be:

UsedPorts

Type: object
No Additional Properties

container_port Required

Container Port

Type: integer

protocol Required

Protocol

Type: string

host_ports Required

Host Ports

Type: array
No Additional Items

Each item of this array must be:

Type: object

state Required

State

Type: enum (of string)

Must be one of:

• "crashed"
• "created"
• "exited"
• "running"
• "starting"

volume_mounts Required

Volume Mounts

Type: array of object
No Additional Items

Each item of this array must be:

AppVolumes

Type: object
No Additional Properties

source Required

Source

Type: string

destination Required

Destination

Type: string

mode Required

Mode

Type: string

type Required

Type

Type: string

volumes Required

Volumes

Type: array of object
No Additional Items

Each item of this array must be:

AppVolumes

Type: object
No Additional Properties

source Required

Source

Type: string

destination Required

Destination

Type: string

mode Required

Mode

Type: string

type Required

Type

Type: string

images Required

Images

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

networks Required

Networks

Type: array of object
No Additional Items

Each item of this array must be:

AppNetworks

Type: object

Name Required

Name

Type: string

Id Required

Id

Type: string

Labels Required

Labels

Type: object

Additional Properties

Additional Properties of any type are allowed.

Type: object

notes Required

Notes

Any of

• Option 1
• Option 2

Type: string

Type: null

portals Required

Portals

Type: object

version_details

Version Details

Default: null

Any of

• Option 1
• Option 2

Type: object

Type: null

config

Config

Default: null

Any of

• Option 1
• Option 2

Type: object

Type: null

Required roles: APPS_WRITE