apiSecurityItem

Represents a discovered API endpoint with its security-related information and metadata.

Examples

type ApiSecurityItem {
  id: String
  scanId: String
  title: String
  description: String
  version: String
  methodDescription: String
  methodOperationId: String
  methodSummary: String
  openapi: String
  servers: [String]
  epName: String
  methodName: String
  methodResponses: [MethodResponse]
  methodTags: [String]
  methodParameters: [MethodParameter]
  appId: String
  appType: String
  appName: String
  fileName: [String]
  definitions: [APIDefinitions]
  framework: String
  language: String
  firstSeen: Date
  uuid: String
  issuesBySeverity: Severities
  codeLocations: [CodeLocation]
  commits: [ApiInventoryCommit]
}

Fields

Field	Description	Supported fields
id String	Unique identifier for this API security item
scanId String	Identifier of the scan that discovered this API item
title String	Title or name of the API endpoint
description String	Detailed description of what this API endpoint does
version String	Version of the API specification
methodDescription String	Description of the HTTP method for this endpoint
methodOperationId String	OpenAPI operation identifier for this method
methodSummary String	Brief summary of what this API method does
openapi String	OpenAPI specification version used
servers [String]	List of server URLs where this API is hosted
epName String	Name of the API endpoint
methodName String	HTTP method name for this endpoint
methodResponses [MethodResponse]	List of possible HTTP responses for this method	description String code String
methodTags [String]	Tags associated with this API method for categorization
methodParameters [MethodParameter]	List of parameters accepted by this API method	description String in String name String required Boolean
appId String	Identifier of the application containing this API
appType String	Type of the application hosting this API
appName String	Name of the application containing this API
fileName [String]	List of file names where this API is defined
definitions [APIDefinitions]	API definition details including source and documentation	source String fileName String link String llmTitle String llmDescription String functions [ApiSecurityItemFunction]
framework String	Framework used to implement this API
language String	Programming language used to implement this API
firstSeen Date	Date when this API was first discovered
uuid String	Unique universal identifier for this API item
issuesBySeverity Severities	Count of security issues found in this API, grouped by severity level	info Int low Int medium Int high Int critical Int appox Int
codeLocations [CodeLocation]	Code locations where this API is implemented or called	link String callBranch [String]
commits [ApiInventoryCommit]	Git commit information related to this API	commitInfo ApiInventoryCommitInfo match String snippet String snippetLineNumber Int startLineNumber Int fileName String link String

References

Fields with this object:

• {} ApiSecurityItemsResponse.apiSecurityItems