v1beta
Double column
curl
API
CLI

Services /

Get service details

Gets information about the given service.

URL parameters

    • project

      string required

      ID of the project

    • service

      string required

      ID of the service

Response attributes

  • object

    • id

      string required

      Identifier for the service

    • appId

      string required

      Full identifier used for service deployment

    • name

      string required

      Service name

    • description

      string

      A short description of the service

    • projectId

      string required

      ID of the project that the service belongs to

    • serviceType

      string required

      Type of the service (combined, build or deployment)

      one of
      combined, build, deployment
    • vcsData

      object

      • projectUrl

        string required

        URL of the repository being built

      • projectType

        string required

        VCS provider for the repo being built

      • vcsId

        string

        ID of the self-hosted VCS, if applicable.

      • projectBranch

        string

        Branch of the repo being built

      • dockerWorkDir

        string required

        Working directory used by the dockerfile

      • dockerFilePath

        string required

        File path of the Dockerfile

    • disabledCI

      boolean required

      Whether Continuous Integration is disabled

    • disabledCD

      boolean required

      Whether Continuous Deployment is disabled

    • buildConfiguration

      object

      • branchRestrictions

        array required

        • string

      • prRestrictions

        array required

        • string

    • deployment

      object

      • region

        string

        Region where this service is deployed and/or built

      • instances

        integer

        Number of instances/replicas running

      • external

        object

        Data about a deployment from an external registry.

        • 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

      • internal

        object

        • 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 to be deployed. 'latest' means the latest commit is automatically being deployed.

        • deployedSHA

          string required

          Currently deployed commit SHA. If buildSHA is set to 'latest', this will show the SHA of the latest commit.

    • billing

      object required

      • deploymentPlan

        string required

        ID of the billing plan used by this service

API
CLI

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

Example response

200 OK

Details about the service.

JSON

{
  "id": "example-service",
  "appId": "/example-user/default-project/example-service",
  "name": "Example Service",
  "description": "This is the service description",
  "projectId": "default-project",
  "serviceType": "combined",
  "vcsData": {
    "projectUrl": "https://github.com/northflank/gatsby-with-northflank",
    "projectType": "github",
    "vcsId": "example-team/self-hosted-vcs",
    "projectBranch": "master",
    "dockerWorkDir": "/",
    "dockerFilePath": "/Dockerfile"
  },
  "disabledCI": false,
  "disabledCD": false,
  "buildConfiguration": {
    "branchRestrictions": [
      "feature/*"
    ],
    "prRestrictions": [
      "feature/*"
    ]
  },
  "deployment": {
    "region": "europe-west",
    "instances": 1,
    "external": {},
    "internal": {
      "appId": "/example-user/default-project/example-service",
      "nfObjectId": "5f3bd676b84798d54472d1cc",
      "nfObjectType": "service",
      "repository": "https://github.com/northflank/gatsby-with-northflank",
      "branch": "master",
      "buildSHA": "latest",
      "deployedSHA": "262ed9817b3cad5142fbceabe0c9e371e390d616"
    }
  },
  "billing": {
    "deploymentPlan": "nf-compute-20"
  }
}

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com