Get app services

GET 
/api/v1/app-services

This API endpoint fetch app services. This API endpoint retrieve a paginated list of app services with detailed information for each app service, including mapped ports attributes and configurations.

Request

Query Parameters

allParams objectrequired

allParams - pageNo, pageSize, sortBy, sortDirection, etc.

Responses

200

Success response

application/json

Schema

Schema

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

payload

object

Schema for paginated response

content

object[]

Array [

appId string

appName string

dnsName string

portMappings

object[]

Array [

targetPort int32

localPort int32

protocol string

description string

]

machineIdOrAliasList string[]

]

totalPages int32

totalRecordCount int64

pageSize int32

Example (from schema)

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

Fetch app services list example

Fetch app services list response example

{
  "success": true,
  "message": "App services fetched successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": {
    "content": [
      {
        "appId": "4dff4ea340f0-aayq-171",
        "appName": "test-app",
        "dnsName": "test-dns.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"
        ]
      }
    ],
    "totalPages": 1,
    "totalRecordCount": 1,
    "pageSize": 1
  }
}

Loading...