GENERAL

Gets details of all existing projects

get/projects

Request

Base URL
https://desktop-rmvpboc/cxrestapi/help
Auth
OAuth 2
Implicithttps://desktop-rmvpboc/CxRestAPI/auth/identity/connect/authorize
Scopessast_api
TypeScript
https://skmtc.dev/checkmarx/apis/checkmarx-rest-api/docs/projects/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

projectNamestring

Name of a specific project (allows % syntax to 'like' functionality)

teamIdstring

Unique ID of a specific team (empty value allowed)

showAlsoDeletedProjectsboolean

Expose deleted project information, default value is "false"

offsetinteger

Get records starting at (limit*offset)

limitinteger

Number of projects to return

Response

idinteger

teamIdinteger

namestring

isPublicboolean

ownerstring

isDeprecatedboolean

isBranchedboolean

originalProjectIdstring

branchedOnScanIdstring

relatedProjectsinteger[]

Example response

[
  {
    "projectQueueSettings": {
      "queueKeepMode": "KeepAll",
      "scansType": "OnlyFull",
      "includeScansInProcess": false,
      "identicalCodeOnly": false
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.