GetProjectWorkspace

This method can be used for the following: Get project workspaces notes and uploaded files meta data for a project you have Edit access to.

Parameters
The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.
Headers
GET /api/ss/project/:id/workspace HTTP/1.1
Host: localhost:3000
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
Query
id (string)
Identifier for the project.
Example:
GET /api/ss/project/5f63de24fa1c9208d3e140b0/workspace HTTP/1.1
Example
The following example is a cURL request to get a project workspace by the project id.
Request
Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X GET 'http://localhost:3000/api/ss/project/5f63de24fa1c9208d3e140b0/workspace' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Response
Response contains a workspace object.
{
   "workspace": {
      "notes": [
         {
            "title": "...",
            "details": "...",
            "assets": [{"name": "...", "id": "..."}],
            "files": [{"name": "...", "type": "...", "file_size_kb": 999, "full_name": "...", "created": "...", "created_by": "...", "id": "..."}],
            "created": "...",
            "created_by": "...",
            "last_updated": "...",
            "id": "..."
         }
      ],
      "files": [
         {
            "name": "...",
            "type": "...",
            "file_size_kb": 999,
            "full_name": "...",
            "created": "...",
            "created_by": "...",
            "id": "..."
         }
      ]
   }
}

GetProjectVulnerabilitiesById

GetTestsuiteById

Last updated 2 months ago