Fetch app service details

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

This API endpoint retrieve details of an app service identified by the provided appId, including port mapping attributes and configurations.

Request

Path Parameters

appId stringrequired

The appId - unique id of the app service

Responses

200

Success response

application/json

Schema

Schema

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

payload

object

Schema for app services response

appId string

appName string

dnsName string

portMappings

object[]

Array [

targetPort int32

localPort int32

protocol string

description string

]

machineIdOrAliasList string[]

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": {
    "appId": "string",
    "appName": "string",
    "dnsName": "string",
    "portMappings": [
      {
        "targetPort": 0,
        "localPort": 0,
        "protocol": "string",
        "description": "string"
      }
    ],
    "machineIdOrAliasList": [
      "string"
    ]
  }
}

App service details example

App service details response example

{
  "success": true,
  "message": "App service details fetched successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": {
    "appId": "4dff4ea340f0-bqja-217",
    "appName": "test-app",
    "dnsName": "fOTQEAx0KMq4fUrJrvwNFva7EvBArDuU.app.mec.sh",
    "portMappings": [
      {
        "targetPort": 3000,
        "localPort": 3001,
        "protocol": "HTTP",
        "description": "test"
      },
      {
        "targetPort": 3002,
        "localPort": 3003,
        "protocol": "HTTP",
        "description": null
      }
    ],
    "machineIds": [
      "29b63e2aaed8-ultp-846",
      "9e31fad197cf-orxd-138"
    ]
  }
}

Loading...