post-insight-resource-results

dci post-insight-resource-results sourceID insightKey [flags]

Replaces all resource results for the specified insight. Any existing unresolved resource results not present in the new set will be removed. The response includes server-computed fields (severity, resolved, enhancement) for each resource result. To delete all resource results, send an empty array.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "description": "Request body for creating or replacing resource results for an insight.",
  "required": [
    "resourceResults"
  ],
  "properties": {
    "resourceResults": {
      "type": "array",
      "description": "A list of resource-level results for creating or updating an insight.",
      "items": {
        "type": "object",
        "description": "A single resource-level result for creating or updating an insight. Server-computed fields (severity, resolved, enhancement) are not accepted here and will be ignored. Identity fields (resourceId, resultType, account, cloudProvider) form the composite key. The fields location and resource_type are set on creation only — any values provided for these fields during subsequent upserts are silently ignored.\n",
        "required": [
          "resourceId",
          "resultType",
          "account",
          "cloudProvider"
        ],
        "properties": {
          "resourceId": {
            "type": "string",
            "description": "The cloud resource identifier."
          },
          "resourceType": {
            "description": "What the resource actually is, e.g. for an EC2 resource ID, this field would be `instance`. Immutable after creation — updates to this field are silently ignored.\n",
            "type": "string",
            "example": "instance, disk, cache"
          },
          "cloudProvider": {
            "description": "Immutable after creation — updates to this field are silently ignored.",
            "allOf": [
              {
                "type": "string",
                "example": "aws",
                "description": "The cloud provider associated with the resource."
              }
            ]
          },
          "account": {
            "type": "string",
            "description": "The cloud account or project ID containing this resource. Immutable after creation — updates to this field are silently ignored."
          },
          "location": {
            "type": "string",
            "description": "Represents the region/zone of the resource in AWS, or equivalent for other providers. Immutable after creation — updates to this field are silently ignored.\n",
            "example": "eu-west-2"
          },
          "externalId": {
            "type": "string",
            "description": "the external ID of the resource in the provider's system for the resource"
          },
          "externalUrl": {
            "type": "string",
            "description": "the URL to the resource-level issue in the provider's system"
          },
          "metadata": {
            "type": "object",
            "description": "contains any additional information for the resource results"
          },
          "resultType": {
            "type": "string",
            "enum": [
              "security_risk",
              "potential_daily_savings",
              "potential_daily_savings_with_recommendation",
              "potential_daily_savings_with_cluster_agent"
            ],
            "description": "The discriminator property that determines which fields are populated in the 'result' object."
          },
          "result": {
            "description": "The result data for this resource. Which fields are populated depends on the resultType. For security_risk: critical, high, medium, low. For potential_daily_savings: value. For potential_daily_savings_with_recommendation: value, current, recommendation. For potential_daily_savings_with_cluster_agent: value, agentInstalled.\n",
            "type": "object",
            "properties": {
              "value": {
                "type": "number",
                "format": "double",
                "description": "the daily saving amount for this result"
              },
              "critical": {
                "type": "integer",
                "description": "number of critical security risks"
              },
              "high": {
                "type": "integer",
                "description": "number of high security risks"
              },
              "medium": {
                "type": "integer",
                "description": "number of medium security risks"
              },
              "low": {
                "type": "integer",
                "description": "number of low security risks"
              },
              "current": {
                "type": "string",
                "description": "the current state (i.e. current instance type)"
              },
              "recommendation": {
                "type": "string",
                "description": "the recommended state (i.e. recommended instance type)"
              },
              "agentInstalled": {
                "type": "boolean",
                "description": "true if the agent is installed"
              }
            }
          }
        }
      }
    }
  }
}

Flags

--max-results: (integer default:1000)

Responses

200 (application/json)

Resource results created/replaced successfully

{
  "type": "object",
  "required": [
    "resourceResults",
    "rowCount"
  ],
  "properties": {
    "resourceResults": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A single resource-level result within an insight, as returned in API responses.",
        "required": [
          "resourceId",
          "resultType",
          "account",
          "cloudProvider"
        ],
        "properties": {
          "resourceId": {
            "description": "The cloud resource identifier.",
            "type": "string"
          },
          "resourceType": {
            "description": "What the resource actually is, eg. for an EC2 resource ID, this field would be `instance`",
            "type": "string",
            "example": "instance, disk, cache"
          },
          "cloudProvider": {
            "type": "string",
            "example": "aws",
            "description": "The cloud provider associated with the resource."
          },
          "account": {
            "type": "string",
            "description": "The cloud account or project ID containing this resource."
          },
          "location": {
            "type": "string",
            "description": "represents the region/zone of the resource in AWS, or equivalent for other providers",
            "example": "eu-west-2"
          },
          "resolved": {
            "type": "boolean",
            "description": "Whether this resource-level issue has been resolved. Computed server-side."
          },
          "severity": {
            "type": "string",
            "enum": [
              "critical",
              "high",
              "medium",
              "low"
            ],
            "description": "The severity level of the finding. Computed server-side from the security risk counts."
          },
          "externalId": {
            "type": "string",
            "description": "the external ID of the resource in the provider's system for the resource"
          },
          "externalUrl": {
            "type": "string",
            "description": "the URL to the resource-level issue in the provider's system"
          },
          "metadata": {
            "type": "object",
            "description": "contains any additional information for the resource results"
          },
          "enhancement": {
            "type": "object",
            "description": "DoiT-managed metadata associated with a resource result.",
            "properties": {
              "tags": {
                "type": "array",
                "description": "Tags assigned to this resource result.",
                "items": {
                  "type": "string"
                }
              },
              "priority": {
                "type": "object",
                "description": "Priority information for this resource result.",
                "properties": {
                  "value": {
                    "type": "string",
                    "description": "The priority level (e.g. Low, Medium, High)."
                  },
                  "priorityScore": {
                    "type": "number",
                    "format": "double",
                    "description": "Numeric priority score."
                  }
                }
              },
              "lastUpdatedBy": {
                "type": "string",
                "description": "The user who last updated this enhancement."
              },
              "lastUpdatedAt": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp of the last update."
              }
            }
          },
          "resultType": {
            "type": "string",
            "enum": [
              "security_risk",
              "potential_daily_savings",
              "potential_daily_savings_with_recommendation",
              "potential_daily_savings_with_cluster_agent"
            ],
            "description": "The discriminator property that determines which fields are populated in the 'result' object."
          },
          "result": {
            "description": "The result data for this resource. Which fields are populated depends on the resultType. For security_risk: critical, high, medium, low. For potential_daily_savings: value. For potential_daily_savings_with_recommendation: value, current, recommendation. For potential_daily_savings_with_cluster_agent: value, agentInstalled.\n",
            "type": "object",
            "properties": {
              "value": {
                "type": "number",
                "format": "double",
                "description": "the daily saving amount for this result"
              },
              "critical": {
                "type": "integer",
                "description": "number of critical security risks"
              },
              "high": {
                "type": "integer",
                "description": "number of high security risks"
              },
              "medium": {
                "type": "integer",
                "description": "number of medium security risks"
              },
              "low": {
                "type": "integer",
                "description": "number of low security risks"
              },
              "current": {
                "type": "string",
                "description": "the current state (i.e. current instance type)"
              },
              "recommendation": {
                "type": "string",
                "description": "the recommended state (i.e. recommended instance type)"
              },
              "agentInstalled": {
                "type": "boolean",
                "description": "true if the agent is installed"
              }
            }
          }
        }
      }
    },
    "pageToken": {
      "type": "string"
    },
    "rowCount": {
      "type": "integer"
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: post-insight-resource-results, postinsightresourceresults