API

api

The API, or Application Programming Interface, object represents information pertaining to an API request and response.

Attributes

CaptionNameTypeDescription
GroupgroupGroup[]

The information pertaining to the API group.

OperationoperationString

Verb/Operation associated with the request

Raw Dataraw_dataJSON

Group:context
The event data as received from the event source.

Record IDrecord_idString

Group:primary
Unique identifier for the object

API Request DetailsrequestRequest Elements[]

Details pertaining to the API request.

API Response DetailsresponseResponse Elements[]

Details pertaining to the API response.

ServiceserviceService[]

The information pertaining to the API service.

UnmappedunmappedUnmapped[]

Data from the source that was not mapped into the schema.

VersionversionString

The version of the API service.

Relationships

API shown in context

Inbound Relationships

These objects and events reference API in their attributes:

Outbound Relationships

API references the following objects and events in its attributes:

This page describes ocsf-1.4.0