Get Project
- 03 May 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Get Project
- Updated on 03 May 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Get Project is available as both a pgutil
command and an HTTP Request, and will get a specified project, and return a ProjectInfo Object object describing the project.
🚀 Quick Example: Getting a Project with Curl
This example gets a project myProject
, authenticating with the API key abc12345
:
curl -X GET -H "X-ApiKey: abc12345" "https://proget.corp.local/api/sca/projects?project=myProject"
Command Specification (CLI)
🚧 Coming Soon 🚧
The sca projects get
command is coming soon. Similar to the HTTP Request, it will display a specified project.
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"
}
Response | Details |
---|---|
200 (Success) | body will contain a ProjectInfo object |
400 (Invalid Input) | indicates invalid or missing properties |
403 (Unauthorized API Key) | indicates a missing, unknown, or unauthorized API Key; the body will be empty |
404 (Project or Release Not Found) | indicates that the specified project or project does not exist |
500 (Server Error) | indicates an unexpected error; the body will contain the message and stack trace, and this will also be logged |
Was this article helpful?