OAuth API を使用してトークンを生成することによって、コントローラへの各 API アクセスコールのアクセストークンを生成できます。

エンドポイントの使用例：

curl -X GET  'https://<controller address>/controller/argento/public-api/v1/applications' \
--header 'Authorization: Bearer <your-token-from-ouath-above>'

指定されたクエリパラメータに基づいてアプリケーションのリストを取得します。

GET controller/argento/public-api/v1/applications

パラメータ

レスポンス

Code 200

アプリケーションリストが正常に取得された場合：

{
  "items": [
    {
      "appdApplicationId": 0,
      "applicationCreatedAt": "string",
      "applicationId": "string",
      "applicationName": "string",
      "applicationSecurityEnabled": true,
      "applicationSecurityEnabledComputed": true,
      "countApmActive": 0,
      "countReady": 0,
      "countSecured": 0,
      "countSecurityEnabled": 0,
      "countSupportedAgent": 0
    }
  ],
  "total": 0
}

Code 400

不正なリクエストです。

{
  "error": "string"
}

Code 500

内部サーバーエラーです。

{
  "error": "string"
}

特定のアプリケーションと指定されたクエリパラメータに基づいて階層のリストを取得します。

GET controller/argento/public-api/v1/applications/{applicationId}/tiers

パラメータ

レスポンス

Code 200

特定のアプリケーションの階層リストが正常に取得されました。

{
"items": [
{
"appdApplicationId": 0,
"appdTierId": 0,
"applicationName": "string",
"countApmActive": 0,
"countReady": 0,
"countSecured": 0,
"countSecurityEnabled": 0,
"countSupportedAgent": 0,
"id": "string",
"tierCreatedAt": "string",
"tierEnableSecurity": true,
"tierEnableSecurityStatus": true,
"tierName": "string"
}
],
"total": 0
}

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

特定の階層と指定されたクエリパラメータに基づいてノードのリストを取得します。

GET controller/argento/public-api/v1/applications/{applicationId}/tiers/{tierId}/nodes

パラメータ

レスポンス

Code 200

ノードリストが正常に取得されました。

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

attackSummaryId が指定されている場合、この API コールは特定の攻撃の詳細を取得します。指定されていない場合、この API は攻撃リストを取得します。

GET controller/argento/public-api/v1/attacks

パラメータ

レスポンス

Code 200

攻撃リストまたは攻撃の詳細が正常に取得されました。

{
  "items": [
    {
      "appdApplicationId": 0,
      "appdBtId": 0,
      "appdTierId": 0,
      "applicationId": "string",
      "applicationName": "string",
      "attackName": "string",
      "attackNote": "string",
      "attackOutcome": "string",
      "attackSource": "string",
      "attackStatus": "string",
      "attackSummaryId": "string",
      "attackTypes": "string",
      "btName": "string",
      "btUuid": "string",
      "firstSeenAt": "string",
      "keyInfo": "string",
      "lastSeenAt": "string",
      "tierId": "string",
      "tierName": "string"
    }
  ],
  "total": 0
}

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

attackSummaryId が指定されている場合、この API コールは特定の攻撃の詳細を取得します。指定されていない場合、この API は攻撃リストを取得します。

GET controller/argento/public-api/v1/attacks/{attackSummaryId}

パラメータ

レスポンス

Code 200

攻撃リストまたは攻撃の詳細が正常に取得されました。

{
  "items": [
    {
      "appdApplicationId": 0,
      "appdBtId": 0,
      "appdTierId": 0,
      "applicationId": "string",
      "applicationName": "string",
      "attackName": "string",
      "attackNote": "string",
      "attackOutcome": "string",
      "attackSource": "string",
      "attackStatus": "string",
      "attackSummaryId": "string",
      "attackTypes": "string",
      "btName": "string",
      "btUuid": "string",
      "firstSeenAt": "string",
      "keyInfo": "string",
      "lastSeenAt": "string",
      "tierId": "string",
      "tierName": "string"
    }
  ],
  "total": 0
}

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

この API コールは、指定されたクエリパラメータに基づいてビジネストランザクションのリストを取得します。

GET controller/argento/public-api/v1/businessTransactions

パラメータ

レスポンス

Code 200

ビジネス トランザクション リストが正常に取得された場合：

{
"items": [
{
"appdApplicationId": 0,
"appdBusinessTransactionId": 0,
"applicationId": "string",
"applicationName": "string",
"attackOutcomeCountAttempted": 0,
"attackOutcomeCountBlocked": 0,
"attackOutcomeCountExploited": 0,
"brmTitle": "string",
"businessRiskScore": 0,
"businessTransactionId": "string",
"businessTransactionName": "string",
"entryTierAppdId": 0,
"entryTierId": "string",
"entryTierName": "string",
"riskScore": 0,
"severityCountCritical": 0,
"severityCountHigh": 0,
"severityCountLow": 0,
"severityCountMedium": 0,
"tierCount": 0,
"totalAttackCount": 0,
"totalVulnCount": 0
}
],
"total": 0
}

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

この API コールは、指定されたクエリパラメータに基づいてビジネストランザクションの詳細を取得します。

GET controller/argento/public-api/v1/businessTransactions/{businessTransactionId}

パラメータ

レスポンス

Code 200

特定のビジネストランザクションの正常かつ詳細な取得：

{
"appdApplicationId": 0,
"appdBusinessTransactionId": 0,
"applicationName": "string",
"brmTitle": "string",
"businessRiskScore": 0,
"businessTransactionName": "string",
"entryTierAppdId": 0,
"entryTierName": "string",
"riskScore": 0,
"riskScoreCard": "string"
}

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

指定されたクエリパラメータに基づいてライブラリのリストを取得します。

GET controller/argento/public-api/v1/libraries

パラメータ

レスポンス

Code 200

ライブラリリストが正常に取得された場合：

{
  "items": [
    {
      "active_internet_breach": true,
      "affectedNodeCount": 0,
      "appdApplicationId": 0,
      "appdTierId": 0,
      "applicationName": "string",
      "easily_exploitable": true,
      "kennaRiskScore": 0,
      "libraryId": "string",
      "malware_exploitable": true,
      "packageCanonicalName": "string",
      "packageId": "string",
      "packageLanguage": "string",
      "packageName": "string",
      "packageVersion": "string",
      "popular_target": true,
      "predicted_exploitable": true,
      "recommendedVersion": "string",
      "remote_code_execution": true,
      "riskScore": 0,
      "severity": "string",
      "severityCountCritical": 0,
      "severityCountHigh": 0,
      "severityCountLow": 0,
      "severityCountMedium": 0,
      "status": "string",
      "tierName": "string",
      "totalVulnCount": 0
    }
  ],
  "total": 0
}

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

指定されたクエリパラメータに基づいてライブラリの詳細を取得します。

GET controller/argento/public-api/v1/libraries/{libraryId}

パラメータ

レスポンス

Code 200

特定のライブラリを正常かつ詳細に取得します。

{
"active_internet_breach": true,
"affectedNodeCount": 0,
"appdApplicationId": 0,
"appdTierId": 0,
"applicationName": "string",
"easily_exploitable": true,
"kennaRiskScore": 0,
"libraryId": "string",
"malware_exploitable": true,
"packageCanonicalName": "string",
"packageId": "string",
"packageLanguage": "string",
"packageName": "string",
"packageVersion": "string",
"popular_target": true,
"predicted_exploitable": true,
"recommendedVersion": "string",
"remote_code_execution": true,
"riskScore": 0,
"severity": "string",
"severityCountCritical": 0,
"severityCountHigh": 0,
"severityCountLow": 0,
"severityCountMedium": 0,
"status": "string",
"tierName": "string",
"totalVulnCount": 0
}

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

指定されたクエリパラメータに基づいたアプリケーションとビジネストランザクションによってビジネスリスクスコアを取得します。

GET controller/argento/public-api/v1/stats/businessRisk

パラメータ

レスポンス

Code 200

ビジネスリスクスコアが正常に取得された場合：

{
"brmTitle": "string",
"businessRiskScore": 0
}

コード 204

更新に成功しましたが、コンテンツはありません。

Code 400

不正なリクエストです。

{
"error": "string"
}

コード 404

リソースが見つかりません

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

指定されたクエリパラメータに基づいて脆弱性のリストを取得します。

GET controller/argento/public-api/v1/vulnerabilities

パラメータ

レスポンス

Code 200

脆弱性リストが正常に取得されました。

{
"items": [
{
"active_internet_breach": true,
"affectedNodeCount": 0,
"appdApplicationId": 0,
"appdTierId": 0,
"applicationName": "string",
"attackSummaryId": "string",
"cveId": "string",
"cveName": "string",
"cvePublishDate": "string",
"cveTitle": "string",
"cweName": "string",
"easily_exploitable": true,
"firstSeenAt": "string",
"hasAttacks": true,
"hasEvent": true,
"hasObservations": true,
"incidentId": "string",
"kennaScore": 0,
"lastSeenAt": "string",
"libraryId": "string",
"malware_exploitable": true,
"packageCanonicalName": "string",
"packageId": "string",
"packageLanguage": "string",
"popular_target": true,
"predicted_exploitable": true,
"remediation": "string",
"remote_code_execution": true,
"riskScore": 0,
"severity": "string",
"status": "Unknown",
"tierId": "string",
"tierName": "string"
}
],
"total": 0
}

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

この API コールは、指定されたクエリパラメータに基づいて脆弱性の詳細を取得します。

GET controller/argento/public-api/v1/vulnerabilities/{cveId}

パラメータ

レスポンス

Code 200

特定の脆弱性の正常かつ詳細な取得です。

{
"createdAt": "string",
"cveId": "string",
"cveTitle": "string",
"cvss3BaseScore": 0,
"cvss3VectorString": "string",
"cweName": "string",
"description": "string",
"kenna": {
"active_internet_breach": true,
"easily_exploitable": true,
"malware_exploitable": true,
"popular_target": true,
"predicted_exploitable": true,
"remote_code_execution": true,
"risk_score_meter": 0
},
"name": "string",
"nvdUrl": "string",
"publishDate": "string",
"remediation": "string",
"severity": "string",
"updatedAt": "string"
}

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

特定の階層 ID に基づいてノードのリストを取得します。

GET controller/argento/public-api/v1/tiers/{tierId}/nodes

パラメータ

レスポンス

Code 200

ノードリストが正常に取得されました。

Code 400

不正なリクエストです。

{
"error": "string"
}

Code 500

内部サーバーエラーです。

{
"error": "string"
}

提供されたリソース ID に基づいて、特定のアプリケーションの securityEnabled ステータスを更新します。

PATCH controller/argento/public-api/v1/applications/{resourceId}

パラメータ

{
  "securityEnabled": true
}

レスポンス

コード 204

更新に成功しましたが、コンテンツはありません。

Code 400

無効な要求（パラメータの欠落または無効なパラメータなど）：

{
"error": "string"
}

コード 404

リソースが見つかりません

{
"error": "string"
}

Code 500

内部サーバエラー:

{
"error": "string"
}

提供されたリソース ID に基づいて、特定のノードの securityEnabled ステータスを更新します。

PATCH controller/argento/public-api/v1/nodes/{resourceId}

パラメータ

レスポンス

コード 204

更新に成功しましたが、コンテンツはありません。

Code 400

無効な要求（パラメータの欠落または無効なパラメータなど）：

{
"error": "string"
}

コード 404

リソースが見つかりません

{
"error": "string"
}

Code 500

内部サーバエラー:

{
"error": "string"
}

提供されたリソース ID に基づいて、特定の階層の securityEnabled ステータスを更新します。

PATCH controller/argento/public-api/v1/tiers/{resourceId}

パラメータ

{
  "securityEnabled": true
}

レスポンス

コード 204

更新に成功しましたが、コンテンツはありません。

Code 400

無効な要求（パラメータの欠落または無効なパラメータなど）：

{
"error": "string"
}

コード 404

リソースが見つかりません

{
"error": "string"
}

Code 500

内部サーバエラー:

{
"error": "string"
}