Get Project

Modified on July 26, 2024

Get Project is available as both a pgutil command and an HTTP Request, and will return information on a specified project, and return a ProjectInfo Object object describing the project.

pgutil builds projects info --project=myProject

Command Specification (CLI)

The builds projects info command is used to get information on a project.

The --project option is always required.

Getting information on a project requires the project (e.g. myProject)

pgutil builds projects info --project=myProject

Example output:

myProject (application)

HTTP Request Specification

To get a project, simply GET to the URL with an appropriate API Key.

GET /api/sca/projects?name=«projectName»

Getting a project requires the project name (e.g. myProject):

GET /api/sca/projects?project=myProject

HTTP Response Specification

A successful (200) response body will contain a ProjectInfo Object object. For example, to getting project myProject, the request would return this:

GET /api/sca/projects?project=myProject

{ 
  "id":1,
  "name":"myProject"
}