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

      Database ID

    • appId

      string required

      Full identifier used for service deployment

    • name

      string required

      Service name

    • description

      string

      A short description of the service

    • internalId

      string required

      Identifier for 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)

    • vcsData

      object

      • projectUrl

        string required

        URL of the repository being built

      • projectType

        string required

        VCS provider for the repo being built

      • 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

    • billing

      object required

      • deploymentPlan

        string required

        ID of the billing plan used by this service

API
CLI

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

Example response

200 OK

Details about the service.

JSON

{
  "_id": "5f3bd676b84798d54472d1cc",
  "appId": "/example-user/default-project/example-service",
  "name": "Example Service",
  "description": "This is the service description",
  "internalId": "example-service",
  "projectId": "5f115c160157bca42a34c967",
  "serviceType": "combined",
  "vcsData": {
    "projectUrl": "https://github.com/northflank/gatsby-with-northflank",
    "projectType": "github",
    "projectBranch": "master",
    "dockerWorkDir": "/",
    "dockerFilePath": "/Dockerfile"
  },
  "disabledCI": false,
  "disabledCD": false,
  "buildConfiguration": {
    "branchRestrictions": [
      "feature/*"
    ],
    "prRestrictions": [
      "feature/*"
    ]
  },
  "deployment": {
    "region": "europe-west",
    "instances": 1
  },
  "billing": {
    "deploymentPlan": "5f108e7a6be9b9bff36942b1"
  }
}

© 2020 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com