Repositories

APIs for managing repository assets

Get repositories

get

Get details on all repositories integrated with Cortex Cloud Application Security, providing detailed information and insights into repository artifacts, configurations, and dependencies.

Required license: Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

Query parameters

searchstringOptional

offsetnumberOptional

limitnumberOptional

Header parameters

AuthorizationstringRequired

{api_key}

Example:

UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Responses

200

application/json

namestringOptional

The name of the repository in the version control system (VCS)

descriptionstringOptional

Description describing the repository

creationDatestringOptional

defaultBranchstringOptional

diskSizenumber · doubleOptional

externalIdstringOptional

idstringOptional

Repository ID

integrationIdstringOptional

isArchivedbooleanOptional

Whether the repository is archived

isBillablebooleanOptional

Whether the repository is billable

isForkedbooleanOptional

Whether the repository is forked

isPublicbooleanOptional

Whether the repository is public

isSelectedbooleanOptional

Whether the repository is selected

lastScanDatestringOptional

observationTimenumber · doubleOptional

The date the repository was last updated

organizationIdstringOptional

ownerstringOptional

Repository owner

projectIdstringOptional

scannedBranchstringOptional

sourcestring · enumOptional

Type of the data source instance, indicating the external system it connects to.

Possible values:

urlstringOptional

URL of the repository

get/public_api/appsec/v1/repositories

GET /public_api/appsec/v1/repositories HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Accept: */*

200

[
  {
    "name": "text",
    "description": "text",
    "creationDate": "text",
    "defaultBranch": "text",
    "diskSize": 1,
    "externalId": "text",
    "id": "text",
    "integrationId": "text",
    "isArchived": true,
    "isBillable": true,
    "isForked": true,
    "isPublic": true,
    "isSelected": true,
    "lastScanDate": "text",
    "observationTime": 1,
    "organizationId": "text",
    "owner": "text",
    "projectId": "text",
    "scanConfiguration": {
      "excludedPaths": [
        "text"
      ],
      "prScanning": {
        "blockOnError": true,
        "isEnabled": true
      },
      "scanners": {
        "GIT_HISTORY": {
          "isEnabled": true,
          "scanOptions": {
            "ANY_ADDITIONAL_PROPERTY": true
          }
        },
        "IAC": {
          "isEnabled": true,
          "scanOptions": {
            "ANY_ADDITIONAL_PROPERTY": true
          }
        },
        "SCA": {
          "isEnabled": true,
          "scanOptions": {
            "ANY_ADDITIONAL_PROPERTY": true
          }
        },
        "SECRETS": {
          "isEnabled": true,
          "scanOptions": {
            "ANY_ADDITIONAL_PROPERTY": true
          }
        }
      },
      "taggingBot": {
        "tagModuleBlocks": true,
        "tagResourceBlocks": true
      }
    },
    "scannedBranch": "text",
    "scannedBranches": [
      {
        "diskSize": 1,
        "firstScanDate": "text",
        "id": "text",
        "isPrimary": true,
        "lastApiCallDate": "text",
        "lastCloneDate": "text",
        "lastCloneSha": "text",
        "lastScanDate": "text",
        "name": "text",
        "repositoryId": "text"
      }
    ],
    "source": "COLLECTOR",
    "status": {
      "apiRead": {
        "reason": "text",
        "status": "INVALID"
      },
      "apiWrite": {
        "reason": "text",
        "status": "INVALID"
      },
      "clone": {
        "reason": "text",
        "status": "INVALID"
      },
      "connection": {
        "reason": "text",
        "status": "INVALID"
      },
      "webhookSubscription": {
        "reason": "text",
        "status": "INVALID"
      },
      "token": {
        "reason": "text",
        "status": "INVALID"
      },
      "ANY_ADDITIONAL_PROPERTY": {
        "reason": "text",
        "status": "INVALID"
      }
    },
    "url": "text"
  }
]

Get a repository

get

Get details on the Application Security repository specified by its asset ID.

Required license: Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

Path parameters

assetIdstringRequired

Asset ID

Header parameters

AuthorizationstringRequired

{api_key}

Example:

UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Responses

200

application/json

namestringOptional

The name of the repository in the version control system (VCS)

descriptionstringOptional

Description describing the repository

creationDatestringOptional

defaultBranchstringOptional

diskSizenumber · doubleOptional

externalIdstringOptional

idstringOptional

Repository ID

integrationIdstringOptional

isArchivedbooleanOptional

Whether the repository is archived

isBillablebooleanOptional

Whether the repository is billable

isForkedbooleanOptional

Whether the repository is forked

isPublicbooleanOptional

Whether the repository is public

isSelectedbooleanOptional

Whether the repository is selected

lastScanDatestringOptional

observationTimenumber · doubleOptional

The date the repository was last updated

organizationIdstringOptional

ownerstringOptional

Repository owner

projectIdstringOptional

scannedBranchstringOptional

sourcestring · enumOptional

Type of the data source instance, indicating the external system it connects to.

Possible values:

urlstringOptional

URL of the repository

get/public_api/appsec/v1/repositories/{assetId}

GET /public_api/appsec/v1/repositories/{assetId} HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Accept: */*

200

{
  "name": "text",
  "description": "text",
  "creationDate": "text",
  "defaultBranch": "text",
  "diskSize": 1,
  "externalId": "text",
  "id": "text",
  "integrationId": "text",
  "isArchived": true,
  "isBillable": true,
  "isForked": true,
  "isPublic": true,
  "isSelected": true,
  "lastScanDate": "text",
  "observationTime": 1,
  "organizationId": "text",
  "owner": "text",
  "projectId": "text",
  "scanConfiguration": {
    "excludedPaths": [
      "text"
    ],
    "prScanning": {
      "blockOnError": true,
      "isEnabled": true
    },
    "scanners": {
      "GIT_HISTORY": {
        "isEnabled": true,
        "scanOptions": {
          "ANY_ADDITIONAL_PROPERTY": true
        }
      },
      "IAC": {
        "isEnabled": true,
        "scanOptions": {
          "ANY_ADDITIONAL_PROPERTY": true
        }
      },
      "SCA": {
        "isEnabled": true,
        "scanOptions": {
          "ANY_ADDITIONAL_PROPERTY": true
        }
      },
      "SECRETS": {
        "isEnabled": true,
        "scanOptions": {
          "ANY_ADDITIONAL_PROPERTY": true
        }
      }
    },
    "taggingBot": {
      "tagModuleBlocks": true,
      "tagResourceBlocks": true
    }
  },
  "scannedBranch": "text",
  "scannedBranches": [
    {
      "diskSize": 1,
      "firstScanDate": "text",
      "id": "text",
      "isPrimary": true,
      "lastApiCallDate": "text",
      "lastCloneDate": "text",
      "lastCloneSha": "text",
      "lastScanDate": "text",
      "name": "text",
      "repositoryId": "text"
    }
  ],
  "source": "COLLECTOR",
  "status": {
    "apiRead": {
      "reason": "text",
      "status": "INVALID"
    },
    "apiWrite": {
      "reason": "text",
      "status": "INVALID"
    },
    "clone": {
      "reason": "text",
      "status": "INVALID"
    },
    "connection": {
      "reason": "text",
      "status": "INVALID"
    },
    "webhookSubscription": {
      "reason": "text",
      "status": "INVALID"
    },
    "token": {
      "reason": "text",
      "status": "INVALID"
    },
    "ANY_ADDITIONAL_PROPERTY": {
      "reason": "text",
      "status": "INVALID"
    }
  },
  "url": "text"
}

Get a repository scan configuration

get

Get the details of an Application Security scan configuration.

Required license: Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

Path parameters

assetIdstringRequired

Header parameters

AuthorizationstringRequired

{api_key}

Example:

UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Responses

200

application/json

The configuration of an Application Security code scanner

excludedPathsstring[]Optional

get/public_api/appsec/v1/repositories/{assetId}/scan-configuration

GET /public_api/appsec/v1/repositories/{assetId}/scan-configuration HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Accept: */*

200

{
  "excludedPaths": [
    "text"
  ],
  "prScanning": {
    "blockOnError": true,
    "isEnabled": true
  },
  "scanners": {
    "GIT_HISTORY": {
      "isEnabled": true,
      "scanOptions": {
        "ANY_ADDITIONAL_PROPERTY": true
      }
    },
    "IAC": {
      "isEnabled": true,
      "scanOptions": {
        "ANY_ADDITIONAL_PROPERTY": true
      }
    },
    "SCA": {
      "isEnabled": true,
      "scanOptions": {
        "ANY_ADDITIONAL_PROPERTY": true
      }
    },
    "SECRETS": {
      "isEnabled": true,
      "scanOptions": {
        "ANY_ADDITIONAL_PROPERTY": true
      }
    }
  },
  "taggingBot": {
    "tagModuleBlocks": true,
    "tagResourceBlocks": true
  }
}

Update a repository scan configuration

put

Update the configuration of an Application Security scan.

Required license: Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

Path parameters

assetIdstringRequired

The unique asset ID of the repository.

Example: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2

Header parameters

AuthorizationstringRequired

{api_key}

Example: your-api-key

x-xdr-auth-idstringRequired

{api_key_id}

Example: 1

Body

excludedPathsstring[]Optional

A list of file or directory paths to exclude from scanning. Paths are relative to the repository root and support wildcard patterns.

Exclude directories: Enter folder names to exclude all files inside, such as node_modules/, tests/, dist/.
Exclude files by pattern: Use wildcards — * for any number of characters, ? for a single character. For example, .*.log excludes all log files, *.min.js excludes all minified JavaScript files.
Use a comma-separated list: Separate multiple exclusions with commas. For example, node_modules/, dist/, docs/.
Avoid leading slashes: Use dist/, not /dist/.

Example: tests/

Responses

204

No content. Indicates that the Scan configuration updated successfully.

No content

put/public_api/appsec/v1/repositories/{assetId}/scan-configuration

PUT /public_api/appsec/v1/repositories/{assetId}/scan-configuration HTTP/1.1
Host: api-yourfqdn
Authorization: your-api-key
x-xdr-auth-id: 1
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "excludedPaths": [
    "tests/"
  ],
  "prScanning": {
    "blockOnError": true,
    "isEnabled": true
  },
  "taggingBot": {
    "tagModuleBlocks": true,
    "tagResourceBlocks": true
  },
  "scanners": {
    "SECRETS": {
      "isEnabled": true,
      "scanOptions": {
        "secretValidation": true,
        "gitHistory": true
      }
    },
    "SCA": {
      "isEnabled": true
    },
    "IAC": {
      "isEnabled": true
    }
  }
}

204

No content. Indicates that the Scan configuration updated successfully.

No content

Get AppSec repository branches

get

Get the details of the Application Security repository branches.

Required license: Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

Path parameters

assetIdstringRequired

Header parameters

AuthorizationstringRequired

{api_key}

Example:

UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Responses

200

application/json

diskSizenumber · doubleOptional

firstScanDatestringOptional

Timestamp of the first scan performed

idstringOptional

Branch ID

isPrimarybooleanOptional

Indicates whether or not the branch is the primary branch

lastApiCallDatestringOptional

lastCloneDatestringOptional

lastCloneShastringOptional

lastScanDatestringOptional

Timestamp of the last scan execution

namestringOptional

Branch name

repositoryIdstringOptional

Repository ID

get/public_api/appsec/v1/repositories/{assetId}/branches

GET /public_api/appsec/v1/repositories/{assetId}/branches HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Accept: */*

200

[
  {
    "diskSize": 1,
    "firstScanDate": "text",
    "id": "text",
    "isPrimary": true,
    "lastApiCallDate": "text",
    "lastCloneDate": "text",
    "lastCloneSha": "text",
    "lastScanDate": "text",
    "name": "text",
    "repositoryId": "text"
  }
]

Update an AppSec repository branch

put

Update the Application Security repository branch by indicating the primary branch.

Required license: Cortex Cloud Posture Management or Cortex Cloud Runtime Security with Application Security add-on.

Path parameters

assetIdstringRequired

Header parameters

AuthorizationstringRequired

{api_key}

Example:

UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Body

selectedBranchesstring[]Required

primaryBranchstringRequired

Responses

204

No content

put/public_api/appsec/v1/repositories/{assetId}/branches

PUT /public_api/appsec/v1/repositories/{assetId}/branches HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "selectedBranches": [
    "text"
  ],
  "primaryBranch": "text"
}

204

No content

PreviousPackage Explorer

NextRemediations

Last updated 6 days ago

Was this helpful?