Fetch machine's app services

GET 
/api/v1/machines/app-services/:machineIdOrAlias

This API endpoint retrieve list of app services identified by the provided machine ID or alias, including port mapping attributes and configurations.

Request

Path Parameters

machineIdOrAlias stringrequired

The machineId - unique id of the machine, alias - machine alias

Responses

200

Success response

application/json

Schema

Schema

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

payload

object[]

Array [

appId string

dnsName string

portMappings

object[]

Array [

targetPort int32

localPort int32

protocol string

description string

]

appName string

]

Example (from schema)

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

Machine's app services example

Machine's app services response example

{
  "success": true,
  "message": "App services fetched successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": [
    {
      "appId": "4dff4ea340f0-aayq-171",
      "appName": "test-app4",
      "dnsName": "test-dns.app.mec.sh",
      "portMappings": [
        {
          "targetPort": 3000,
          "localPort": 3001,
          "protocol": "HTTP",
          "description": "test"
        },
        {
          "targetPort": 3002,
          "localPort": 3003,
          "protocol": "HTTP",
          "description": null
        }
      ]
    }
  ]
}

Loading...