v1
Double column
API
CLI
JS Client

Services /

Get service deployment details

Gets information about the deployment of the given service.

Required permission

Project > Services > Deployment > View Instances

Path parameters

    • projectId

      string required

      ID of the project

    • serviceId

      string required

      ID of the service

Response body

  • {object}

    Response object.

    • data

      (multiple options) required

      Result data.

      • {object}

        Service deploying a Northflank entity

        • region

          string

          Region where this service is deployed and/or built

        • instances

          integer

          Number of instances/replicas running

        • internal

          {object} required
          • appId

            string required

            Full identifier of deployed entity

          • nfObjectId

            string required

            ID of deployed entity

          • nfObjectType

            string required

            Type of deployed entity

            one of
            service
          • repository

            string required

            URL of the repository being deployed

          • branch

            string required

            Branch of the repo being deployed

          • buildSHA

            string required

            Commit SHA being deployed. 'latest' means the latest commit is automatically being deployed.

        OR

      • {object}

        Service deploying an external image

        • region

          string

          Region where this service is deployed and/or built

        • instances

          integer

          Number of instances/replicas running

        • external

          {object} required
          • imagePath

            string required

            Path of the external image excluding the hostname

          • registryProvider

            string required

            Registry provider hosting the external image

            one of
            dockerhub, gcr-eu, gcr-us, gitlab, github, custom
          • privateImage

            boolean required

            Does the image require authentication

API
CLI
JS Client

GET /v1/projects/{projectId}/services/{serviceId}/deployment

Example response

200 OK

Data about the service deployment.

JSON

{
  "data": {
    "region": "europe-west",
    "instances": 1,
    "internal": {
      "appId": "/example-user/default-project/example-service",
      "nfObjectId": "example-service",
      "nfObjectType": "service",
      "repository": "https://github.com/northflank/gatsby-with-northflank",
      "branch": "master",
      "buildSHA": "latest"
    }
  }
}
OR

JSON

{
  "data": {
    "region": "europe-west",
    "instances": 1,
    "external": {
      "imagePath": "nginx:latest",
      "registryProvider": "dockerhub",
      "privateImage": false
    }
  }
}

© 2022 Northflank Ltd. All rights reserved.