v1beta
Double column
curl
API
CLI

Projects /

Get project details

Get information about the given project

URL parameters

    • project

      string required

      ID of the project

Response attributes

  • object

    • id

      string required

      Identifier for the project.

    • name

      string required

      The name of the project.

    • description

      string

      A short description of the project.

    • deployment

      object required

      • region

        string required

        The region where the project's services, jobs and addons are deployed in.

    • services

      array required

      An array of services belonging to the project.

      • object

        A service object.

        • id

          string required

          Identifier for the service.

        • appId

          string required

          Full identifier used for service deployment

        • name

          string required

          The name of the service.

        • description

          string

          A short description of the service.

        • serviceType

          string required

          Type of the service (combined, build or deployment)

          one of
          combined, build, deployment
    • jobs

      array required

      An array of jobs belonging to the project.

      • object

        A job object.

        • id

          string required

          Identifier for the job.

        • appId

          string required

          Full identifier used for deployment

        • name

          string required

          The name of the job.

        • description

          string

          A short description of the job.

        • jobType

          string required

          Type of the service (normal or cron)

          one of
          normal, cron
    • addons

      array required

      An array of addons belonging to the project.

      • object

        An addon object.

        • id

          string required

          Identifier for the addon.

        • appId

          string required

          Full identifier used for deployment

        • name

          string required

          The name of the addon.

        • description

          string

          A short description of the addon.

        • spec

          object required

          Details about the addon's specifications.

          • type

            string required

            The type of the addon

API
CLI

GET /v1/projects/{project}

Example response

200 OK

Details about the given project.

JSON

{
  "id": "default-project",
  "name": "Default Project",
  "description": "The project description",
  "deployment": {
    "region": "europe-west"
  },
  "services": [
    {
      "id": "example-service",
      "appId": "/example-user/default-project/example-service",
      "name": "Example Service",
      "description": "This is the service description",
      "serviceType": "combined"
    }
  ],
  "jobs": [
    {
      "id": "example-job",
      "appId": "/example-user/default-project/example-job",
      "name": "Example Job",
      "description": "This is the job description",
      "jobType": "cron"
    }
  ],
  "addons": [
    {
      "id": "example-addon",
      "appId": "/example-user/default-project/example-addon",
      "name": "Example Addon",
      "description": "This is the addon description",
      "spec": {
        "type": "mongodb"
      }
    }
  ]
}

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com