Get Project Details

This API allows users to get to retrieve specific configuration, status, and related data for a given project.

Authentication

Response data is subject to user roles and permissions.

Method: Bearer Token or API Key

Details: For bearer token header name should be X-OpsMx-Auth. API keys can be generated from the SSD UI.

Request Details

Endpoint URL

Method	URL Path
GET	{host}/ssdservice/v1/{scanType}/projects/{projectID}

Request Headers

Header	Description
Content-Type	application/json
X-OpsMx-Auth	Bearer Token for authentication

CURL Example

curl --location '{host}/gate/ssdservice/v1/sourceScan/projects/{projectID}?teamId=3c5c9dcb-8466-4e06-8ea0-07f9820df897&orgId=bbcd3005-5a94-4ab8-a42d-449bb11e78a9' \
--header 'X-OpsMx-Auth: Bearer <token>'

Response Details

Success Response (Status Code: 200/201)

{
    "OpsMx": {
        "docker-swarm": [
            {
                "branch": "main",
                "lastScanDuration": 9.636670818,
                "lastScannedAt": "2025-12-09T06:21:27.441341088Z",
                "triggeredBy": "system",
                "triggerType": "auto",
                "artifactName": "docker-swarm-main",
                "artifactTag": "98394245298c492b5488c9df39fdee209a955610",
                "artifactSha": "sha256:98394245298c492b5488c9df39fdee209a955610",
                "status": "Completed",
                "notificationData": {
                    "alerts": 58
                }
            }
        ]
    }
}

Error Responses

Status Code	Description	Example Error Response
400	Bad Request (Invalid parameters or missing required fields)	{"error": "Invalid input data."}
401	Unauthorized (Missing or invalid authentication token)	{"error": "Authentication required."}
500	Some issues in Server	{"error": "Resource not found."}