Internet Explorer is no longer supported. Many things will still work, but your experience will be degraded and some things won't function. Please use a modern browser such as Edge, Chrome, or Firefox.

Get Project

view on GitHub

Get Project is available as an HTTP Request, and will return information on a specified project, and return a ProjectInfo Object object describing the 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 Not Found) indicates that the specified 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