Update app service details

PUT 
/api/v1/app-services/:appId

This API endpoint update the app name, DNS name, port mapping, and assigned machines of the app service identified by the provided appId

Request

Path Parameters

appId stringrequired

The appId - unique id of the app service

application/json

Body

required

The request body containing the required details to update app service details

appName string
dnsName string

portMappings

object[]

Array [

targetPort int32

Possible values: >= 1 and <= 65535

localPort int32

Possible values: >= 1 and <= 65535

description string

]

machineIdOrAliasList string[]

Responses

200

Success response

application/json

Schema

Schema

success boolean
message string
status string
statusCode int32
errorCode string
subErrors object[]
payload boolean

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": true
}

Update app service details example

Update app service details response example

{
  "success": true,
  "message": "App service updated successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": true
}

Loading...