Update App Using PUT
API code: UPDATE-APP
Pre-authorized role(s): PROVIDER_ADMIN
Request
URI
PUT
https://{api_host}//localhost/api/alp/v1/apps/{app-id}
COPY
Path Parameters
string
app-id
Required
Marketplace app template ID.
Request Body
Request for updating an app.
AppUpdateRequest of type(s) application/json
Optional
{
"categories": [
"string"
],
"description": "string",
"instructions": "string",
"logo": "string",
"os": "string",
"screenshot_link": "string",
"spec": "string",
"summary": "string",
"title": "string"
}
array of string
categories
Optional
categories
string
description
Optional
description
string
instructions
Optional
instructions
string
logo
Optional
logo
string
os
Optional
os
string
screenshot_link
Optional
screenshot_link
string
spec
Optional
spec
string
summary
Optional
summary
string
title
Optional
title
Responses
200
OK
Returns App of type(s) application/json
{
"app_id": "string",
"busy": false,
"catalog_id": "string",
"catalog_name": "string",
"categories": [
"string"
],
"common_info": {
"field": "string",
"value": "string"
},
"creation_date": "string",
"description": "string",
"editable": false,
"featured": false,
"hardware_requirement": {
"disk_gb": "number",
"memory_gb": "number",
"vcpu_num": 0
},
"has_details": false,
"instructions": "string",
"logo": "string",
"name": "string",
"number_of_instances": 0,
"number_of_using_orgs": 0,
"org_id": "string",
"os": "string",
"screenshot_links": [
"string"
],
"source": "string",
"spec": "string",
"status": {
"code": "string",
"reason": "string"
},
"summary": "string",
"title": "string",
"type": "string",
"version": "string"
}
string
app_id
Optional
app_id
boolean
busy
Optional
busy
string
catalog_id
Optional
catalog_id
string
catalog_name
Optional
catalog_name
array of string
categories
Optional
categories
string As date-time As date-time
creation_date
Optional
creation_date
string
description
Optional
description
boolean
editable
Optional
editable
boolean
featured
Optional
featured
boolean
has_details
Optional
has_details
string
instructions
Optional
instructions
string
logo
Optional
logo
string
name
Optional
name
integer As int32 As int32
number_of_instances
Optional
number_of_instances
integer As int32 As int32
number_of_using_orgs
Optional
number_of_using_orgs
string
org_id
Optional
org_id
string
os
Optional
os
array of string
screenshot_links
Optional
screenshot_links
string
source
Optional
source
string
spec
Optional
spec
string
summary
Optional
summary
string
title
Optional
title
string
type
Optional
type
Possible values are : VM, HELM,
string
version
Optional
version
On This Page
Applications Operations
DELETE
Delete App Using DELETE
GET
Get Apps Using GET
GET
Get App Using GET
GET
Get Featured Apps Using GET
GET
Get Helm App Values Yaml Using GET
GET
Get Launchable Apps Using GET
POST
Import App Using POST
PUT
Update App Using PUT
PATCH
Update Featured Apps Using PATCH
POST
Upload App From Remote URL Using POST