v1beta
ApplicationAPI & CLI
Double column
curl
API
CLI

Services /

Get ports

Lists the ports for the given service.

URL parameters

    • project

      string required

      ID of the project

    • service

      string required

      ID of the service

Response attributes

  • object

    • ports

      array required

      • object

        • id

          string required

          The id used to identify the port across requests.

          pattern
          ^[a-z]-?[a-z0-9]+(-[a-z0-9]+)*$

        • name

          string required

          The name of the port used in the public url and UI.

          pattern
          ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

        • internalPort

          integer required

          The port number.

        • protocol

          string required

          The protocol used by the port.

          one of
          HTTP, TCP, UDP

        • public

          boolean required

          If true, the port is exposed publicly.

        • domains

          array required

          An array of domains that redirect to this port.

          • string

API
CLI

GET /v1/projects/{project}/services/{service}/ports

Example response

200 OK

Details about the ports for the service.

JSON

{
  "ports": [
    {
      "id": "eonyui",
      "name": "port-1",
      "internalPort": 8080,
      "protocol": "HTTP",
      "public": true,
      "domains": [
        null
      ]
    }
  ]
}

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com