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

    • name

      string required

    • description

      string

    • internalId

      string required

    • services

      array required

      • object

        • _id

          string required

        • appId

          string required

        • name

          string required

        • description

          string

        • internalId

          string required

        • serviceType

          string required

    • jobs

      array required

      • object

        • _id

          string required

        • appId

          string required

        • name

          string required

        • description

          string

        • internalId

          string required

        • jobType

          string required

API
CLI

GET /v1beta/projects/{project}

Example response

200 OK

Details about the given project.

JSON

{
  "_id": "5f115c160157bca42a34c967",
  "name": "Default Project",
  "description": "The project description",
  "internalId": "default-project",
  "services": [
    {
      "_id": "5f3bd676b84798d54472d1cc",
      "appId": "/example-user/default-project/example-service",
      "name": "Example Service",
      "description": "This is the service description",
      "internalId": "example-service",
      "serviceType": "combined"
    }
  ],
  "jobs": [
    {
      "_id": "5f3b89d91177f4ce75f6f1f9",
      "appId": "/example-user/default-project/example-job",
      "name": "Example Job",
      "description": "This is the job description",
      "internalId": "example-job",
      "jobType": "cron"
    }
  ]
}

© 2020 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com