v1beta
ApplicationAPI & CLI
Double column
curl
API
CLI

Services /

Get service deployment details

Gets information about the deployment of the given service.

URL parameters

    • project

      string required

      ID of the project

    • service

      string required

      ID of the service

Response attributes

  • (multiple options)

    • object

      Service deploying a Northflank entity

      • internal

        object required

        • appId

          string required

          Full identifier of deployed entity

        • nfObjectId

          string required

          Database ID of deployed entity

        • nfObjectType

          string required

          Type of deployed entity

        • 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

      • 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

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

Example response

200 OK

Deployment data

JSON

{
  "internal": {
    "appId": "/example-user/default-project/example-service",
    "nfObjectId": "5f3bd676b84798d54472d1cc",
    "nfObjectType": "service",
    "repository": "https://github.com/northflank/gatsby-with-northflank",
    "branch": "master",
    "buildSHA": "latest"
  }
}

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com