PUT - /item/deploy/configure

General Information

Service	API	Method	Data Models	Workflow

Service	API	Method	Data Models	Workflow
marketplace	/item/deploy/configure	PUT	N/A	N/A

Description

This API updates the deployment configuration of an item.

Input

Type: application/json

Param	Source	Type	Required	Description

Param	Source	Type	Required	Description
type	query	string	Yes
name	query	string	Yes
config	body	object	Yes
env	body.config	string	Yes
version	body.config	string	Yes
cd	body.config	object	Yes
strategy	body.config.cd	enum	Yes	["notify", "update"]
settings	body.config	object	Yes
memory	body.config.settings	string	Yes
mode	body.config.settings	enum	Yes	["Deployment", "DaemonSet", "CronJob"]
concurrencyPolicy	body.config.settings	enum	No	["Allow", "Forbid", "Replace"]
schedule	body.config.settings	string	No
restartPolicy	body.config.settings	enum	No	["OnFailure", "Never"]
replicas	body.config.settings	integer
src	body.config	object	No
from	body.config.src	object	Yes
id	body.config.src	string	Yes
autoScale	body.config	object	No
replicas	body.config.autoScale	object	Yes
min	body.config.autoScale.replicas	integer	yes	min 1
max	body.config.autoScale.replicas	integer	yes	min 1
metrics	body.config.autoScale	object	Yes
cpu	body.config.autoScale.metrics	object	Yes
percent	body.config.autoScale.metrics.cpu	number	Yes
recipe	body.config	object	Yes
id	body.config.recipe	string	Yes
image	body.config.recipe	object	No
name	body.config.recipe.image	string	Yes
prefix	body.config.recipe.image	string	Yes
tag	body.config.recipe.image	string	Yes
ports	body.config.recipe	object	No
type	body.config.recipe.ports	string	Yes
portType	body.config.recipe.ports	string	Yes
externalTrafficPolicy	body.config.recipe.ports	enum	No	`["Local", "Cluster"]`
values	body.config.recipe.ports	array of object	Yes
name	body.config.recipe.ports.externalTrafficPolicy	string	Yes
target	body.config.recipe.ports.externalTrafficPolicy	integer	No
isPublished	body.config.recipe.ports.externalTrafficPolicy	boolean	No
env	body.config.recipe	object	No
sourceCode	body.config.recipe	object	No

body.config.src.from

Conditional require, with one of the following:

["tag"]
["branch", "commit"]

Param	Source	Type	Required	Description

Param	Source	Type	Required
tag	body.config.src.from	string	Yes conditional
branch	body.config.src.from	string	Yes conditional
commit	body.config.src.from	string	Yes conditional

body.config.recipe.env

Any of the below:

"^.*$" as string
"^.*$" as object

Param	Source	Type	Required	Description

Param	Source	Type	Required
`"^.*$"`	body.config.recipe.env	string	Yes
`"^.*$"`	body.config.recipe.env	object	yes
	body.config.recipe.env….	string	yes
	body.config.recipe.env….	string	yes

body.config.recipe.sourceCode

Conditional require, with one of the following:

["label", "catalog", "id", "version", "tag"]
["label", "catalog", "id", "version", "branch", "commit"]

Param	Source	Type	Required	Description

Param	Source	Type	Required
label	body.config.recipe.sourceCode	string	Yes conditional
catalog	body.config.recipe.sourceCode	string	Yes conditional
id	body.config.recipe.sourceCode	string	Yes conditional
version	body.config.recipe.sourceCode	string	Yes conditional
branch	body.config.recipe.sourceCode	string	Yes conditional
tag	body.config.recipe.sourceCode	string	Yes conditional
commit	body.config.recipe.sourceCode	string	Yes conditional

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

{
	"result": true,
	"data": "Catalog Item Configuration Successfully updated!"
}

Invalid Response

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description

Code	Description
400	Business logic required data are missing
405	Recipe not allowed for this item!
406	You are not allowed to deploy this item in this environment!
501	Item not found!
602	Model error: + %model_error%
603	Model item not updated!