Create an application
Creates a long-running application in an environment, built from a GitHub repository or deployed from a container image.
/project/{project_id}/environment/{environment_id}/applicationAuthorizationBearer token (JWT) · headerrequiredJWT token passed in the Authorization header using the Bearer <token> format.
project_iduuidrequiredThe unique identifier for the project
environment_iduuidrequiredThe unique identifier of the environment
application/jsonnamestringrequiredName of the application component.
descriptionstringconfigurationobjectrequiredShow propertiesHide properties
cpu_limit_in_millistringMaximum CPU allocated to the application. Unit is millicores (m).
ram_limit_in_mibstringMaximum memory allocated to the application.
cpu_request_in_millistringRequested CPU. Unit is millicores (m).
ram_request_in_mibstringRequested memory.
gpu_limitintegerOptional GPU count.
min_running_instancesintegerMinimum number of running instances.
max_running_instancesintegerMaximum number of running instances.
sourceapplication_container_source | application_github_source_inputrequiredShow propertiesHide properties
typestringrequiredContainer source discriminator.
containerimage_namestringrequiredimage name
tagstringrequiredtag of the image container
typestringrequiredgithubinstallation_iduuidrequiredA universally unique identifier (UUID) string
repository_idstringrequiredbranchstringrequiredtrigger_policyobjectShow propertiesHide properties
automaticbooleanpath_modestringControls whether changed repository paths include or exclude an automatic build.
noneincludeexcludepathsstring[]Repository-relative, case-sensitive patterns used by the selected path mode.
build_policyobjectrequiredShow propertiesHide properties
contextstringcpu_request_in_millistringrequiredcpu_limit_in_millistringrequiredram_request_in_mibstringrequiredram_limit_in_mibstringrequiredtimeout_secondsintegerhealthcheckshealthcheckrequiredConfiguration object for health check probes including readiness and liveness probe settings
Show propertiesHide properties
readiness_probeprobe | nullConfiguration for health check probes used to determine the health status of a container or service. Supports multiple probe types including TCP, HTTP, exec command, and gRPC.
Show propertiesHide properties
typeobjectShow propertiesHide properties
tcpobject | nullShow propertiesHide properties
portintegerhoststring | nullhttpobject | nullShow propertiesHide properties
pathstringschemestringportintegerexecobject | nullShow propertiesHide properties
commandstring[]grpcobject | nullShow propertiesHide properties
servicestring | nullportintegerinitial_delay_secondsintegerperiod_secondsintegertimeout_secondsintegersuccess_thresholdintegerfailure_thresholdintegerliveness_probeprobe | nullConfiguration for health check probes used to determine the health status of a container or service. Supports multiple probe types including TCP, HTTP, exec command, and gRPC.
Show propertiesHide properties
typeobjectShow propertiesHide properties
tcpobject | nullShow propertiesHide properties
portintegerhoststring | nullhttpobject | nullShow propertiesHide properties
pathstringschemestringportintegerexecobject | nullShow propertiesHide properties
commandstring[]grpcobject | nullShow propertiesHide properties
servicestring | nullportintegerinitial_delay_secondsintegerperiod_secondsintegertimeout_secondsintegersuccess_thresholdintegerfailure_thresholdintegerportsapplication_port[]Show propertiesHide properties
application_portiduuidA universally unique identifier (UUID) string
namestringrequiredHuman-readable port name.
is_defaultbooleanrequiredWhether this is the default port for future domain routing.
internal_portintegerrequiredListening port inside the application.
external_portinteger | nullOptional exposed port, persisted for future exposure features.
protocolapplication_protocolrequiredApplication port protocol.
HTTPGRPCTCPUDPstoragesapplication_storage[]Show propertiesHide properties
application_storageiduuidA universally unique identifier (UUID) string
namestringrequiredHuman-readable storage name.
mount_pathstringrequiredAbsolute path mounted into the application.
size_in_gibintegerrequiredPersistent volume size in GiB.
storage_typestringrequiredKubernetes storage class name.
entrypointstringApplication entrypoint.
argumentsstring[]Application created successfully
iduuidrequiredA universally unique identifier (UUID) string
organization_iduuidrequiredA universally unique identifier (UUID) string
project_iduuidrequiredA universally unique identifier (UUID) string
cluster_iduuidrequiredA universally unique identifier (UUID) string
environment_iduuidrequiredA universally unique identifier (UUID) string
namestringrequiredName of the application component.
descriptionstringlast_run_iduuid | nullShow propertiesHide properties
string<uuid>nulllast_run_statuscomponent_deployment_stateDeployment state for a component resource.
QUEUEDSCHEDULEDRUNNINGRETRYINGSUCCEEDEDFAILEDCANCELEDTIMED_OUTSKIPPEDNONEconfigurationobjectrequiredShow propertiesHide properties
cpu_limit_in_millistringrequiredMaximum CPU allocated to the application. Unit is millicores (m).
ram_limit_in_mibstringrequiredMaximum memory allocated to the application.
cpu_request_in_millistringrequiredRequested CPU. Unit is millicores (m).
ram_request_in_mibstringrequiredRequested memory.
gpu_limitintegerGPU count.
min_running_instancesintegerrequiredmax_running_instancesintegerrequiredsourceapplication_container_source | application_github_sourcerequiredShow propertiesHide properties
typestringrequiredContainer source discriminator.
containerimage_namestringrequiredimage name
tagstringrequiredtag of the image container
typestringrequiredgithubinstallation_iduuidrequiredA universally unique identifier (UUID) string
repository_idstringrequiredrepository_ownerstringrequiredrepository_namestringrequiredrepository_full_namestringrequiredrepository_privatebooleanrequiredrepository_archivedbooleanrequiredrepository_default_branchstringrequiredbranchstringrequiredavailabilitystringrequiredLive, response-only attention state for the exact configured source identity.
availableinstallation_suspendedinstallation_deletedrepository_unavailablebranch_unavailablegithub_unavailabletrigger_policyobjectrequiredShow propertiesHide properties
automaticbooleanrequiredpath_modestringrequirednoneincludeexcludepathsstring[]requiredbuild_policyobjectrequiredShow propertiesHide properties
contextstringrequiredcpu_request_in_millistringrequiredcpu_limit_in_millistringrequiredram_request_in_mibstringrequiredram_limit_in_mibstringrequiredtimeout_secondsintegerrequiredhealthcheckshealthcheckrequiredConfiguration object for health check probes including readiness and liveness probe settings
Show propertiesHide properties
readiness_probeprobe | nullConfiguration for health check probes used to determine the health status of a container or service. Supports multiple probe types including TCP, HTTP, exec command, and gRPC.
Show propertiesHide properties
typeobjectShow propertiesHide properties
tcpobject | nullShow propertiesHide properties
portintegerhoststring | nullhttpobject | nullShow propertiesHide properties
pathstringschemestringportintegerexecobject | nullShow propertiesHide properties
commandstring[]grpcobject | nullShow propertiesHide properties
servicestring | nullportintegerinitial_delay_secondsintegerperiod_secondsintegertimeout_secondsintegersuccess_thresholdintegerfailure_thresholdintegerliveness_probeprobe | nullConfiguration for health check probes used to determine the health status of a container or service. Supports multiple probe types including TCP, HTTP, exec command, and gRPC.
Show propertiesHide properties
typeobjectShow propertiesHide properties
tcpobject | nullShow propertiesHide properties
portintegerhoststring | nullhttpobject | nullShow propertiesHide properties
pathstringschemestringportintegerexecobject | nullShow propertiesHide properties
commandstring[]grpcobject | nullShow propertiesHide properties
servicestring | nullportintegerinitial_delay_secondsintegerperiod_secondsintegertimeout_secondsintegersuccess_thresholdintegerfailure_thresholdintegerportsapplication_port[]requiredShow propertiesHide properties
application_portiduuidA universally unique identifier (UUID) string
namestringrequiredHuman-readable port name.
is_defaultbooleanrequiredWhether this is the default port for future domain routing.
internal_portintegerrequiredListening port inside the application.
external_portinteger | nullOptional exposed port, persisted for future exposure features.
protocolapplication_protocolrequiredApplication port protocol.
HTTPGRPCTCPUDPstoragesapplication_storage[]requiredShow propertiesHide properties
application_storageiduuidA universally unique identifier (UUID) string
namestringrequiredHuman-readable storage name.
mount_pathstringrequiredAbsolute path mounted into the application.
size_in_gibintegerrequiredPersistent volume size in GiB.
storage_typestringrequiredKubernetes storage class name.
entrypointstringargumentsstring[]Error
codeinteger<int32>requiredmessagestringrequiredreasonstringOptional stable machine-readable reason for programmatic error handling