HTTP Request

http_request

The HTTP Request object represents the attributes of a request made to a web server. It encapsulates the details and metadata associated with an HTTP request, including the request method, headers, URL, query parameters, body content, and other relevant information.

Contents

Attributes

Caption Name Type Is Array Default Description
HTTP Arguments args String The arguments sent along with the HTTP request.
HTTP Headers http_headers HTTP Header Additional HTTP headers of an HTTP request or response.
HTTP Method http_method String The HTTP request method indicates the desired action to be performed for a given resource.
CONNECT
Connect
DELETE
Delete
GET
Get
HEAD
Head
OPTIONS
Options
POST
Post
PUT
Put
TRACE
Trace
Request Length length Integer The HTTP request length, in number of bytes.
Prefix prefix String Domain prefix.

Deprecated since 1.1.0: Deprecated in upgrade from ocsf-0.31.1 to qdm-1.1.0

Raw Data raw_data JSON The event data as received from the event source.
Record ID record_id String Unique identifier for the object
HTTP Referrer referrer String The request header that identifies the address of the previous web page, which is linked to the current web page or resource being requested.
Unique ID uid String The unique identifier of the http request.
Unmapped Data unmapped Unmapped The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.
URL url Uniform Resource Locator The URL object that pertains to the request.
HTTP User-Agent user_agent String The request header that identifies the operating system and web browser.
HTTP Version version String The Hypertext Transfer Protocol (HTTP) version.
X-Forwarded-For x_forwarded_for IP Address The X-Forwarded-For header identifying the originating IP address(es) of a client connecting to a web server through an HTTP proxy or a load balancer.

Context

HTTP Request

JSON

            
{
  "caption": "HTTP Request",
  "description": "The HTTP Request object represents the attributes of a request made to a web server. It encapsulates the details and metadata associated with an HTTP request, including the request method, headers, URL, query parameters, body content, and other relevant information.",
  "extends": "object",
  "name": "http_request",
  "attributes": {
    "args": {
      "requirement": "optional",
      "caption": "HTTP Arguments",
      "description": "The arguments sent along with the HTTP request.",
      "type": "string_t"
    },
    "http_headers": {
      "requirement": "recommended",
      "caption": "HTTP Headers",
      "description": "Additional HTTP headers of an HTTP request or response.",
      "is_array": true,
      "type": "http_header"
    },
    "http_method": {
      "caption": "HTTP Method",
      "description": "The <a target='_blank' href='https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods'>HTTP request method</a> indicates the desired action to be performed for a given resource.",
      "enum": {
        "CONNECT": {
          "caption": "Connect",
          "description": "The CONNECT method establishes a tunnel to the server identified by the target resource."
        },
        "DELETE": {
          "caption": "Delete",
          "description": "The DELETE method deletes the specified resource."
        },
        "GET": {
          "caption": "Get",
          "description": "The GET method requests a representation of the specified resource. Requests using GET should only retrieve data."
        },
        "HEAD": {
          "caption": "Head",
          "description": "The HEAD method asks for a response identical to a GET request, but without the response body."
        },
        "OPTIONS": {
          "caption": "Options",
          "description": "The OPTIONS method describes the communication options for the target resource."
        },
        "POST": {
          "caption": "Post",
          "description": "The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server."
        },
        "PUT": {
          "caption": "Put",
          "description": "The PUT method replaces all current representations of the target resource with the request payload."
        },
        "TRACE": {
          "caption": "Trace",
          "description": "The TRACE method performs a message loop-back test along the path to the target resource."
        }
      },
      "type": "string_t",
      "requirement": "recommended"
    },
    "length": {
      "caption": "Request Length",
      "description": "The HTTP request length, in number of bytes.",
      "requirement": "optional",
      "type": "integer_t"
    },
    "referrer": {
      "requirement": "optional",
      "caption": "HTTP Referrer",
      "description": "The request header that identifies the address of the previous web page, which is linked to the current web page or resource being requested.",
      "type": "string_t"
    },
    "uid": {
      "description": "The unique identifier of the http request.",
      "requirement": "optional",
      "caption": "Unique ID",
      "type": "string_t"
    },
    "url": {
      "description": "The URL object that pertains to the request.",
      "requirement": "recommended",
      "caption": "URL",
      "type": "url"
    },
    "user_agent": {
      "requirement": "recommended",
      "caption": "HTTP User-Agent",
      "observable": 16,
      "description": "The request header that identifies the operating system and web browser.",
      "type": "string_t"
    },
    "version": {
      "caption": "HTTP Version",
      "description": "The Hypertext Transfer Protocol (HTTP) version.",
      "requirement": "recommended",
      "type": "string_t"
    },
    "x_forwarded_for": {
      "requirement": "optional",
      "caption": "X-Forwarded-For",
      "description": "The X-Forwarded-For header identifying the originating IP address(es) of a client connecting to a web server through an HTTP proxy or a load balancer.",
      "is_array": true,
      "type": "ip_t"
    },
    "raw_data": {
      "group": "context",
      "caption": "Raw Data",
      "description": "The event data as received from the event source.",
      "type": "json_t"
    },
    "record_id": {
      "description": "Unique identifier for the object",
      "group": "primary",
      "requirement": "required",
      "caption": "Record ID",
      "type": "string_t"
    },
    "unmapped": {
      "caption": "Unmapped Data",
      "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.",
      "type": "unmapped",
      "is_array": true
    },
    "prefix": {
      "description": "Domain prefix.",
      "requirement": "optional",
      "caption": "Prefix",
      "type": "string_t",
      "@deprecated": {
        "since": "1.1.0",
        "message": "Deprecated in upgrade from ocsf-0.31.1 to qdm-1.1.0"
      }
    }
  },
  "constraints": {
    "at_least_one": [
      "user_agent",
      "url",
      "hostname"
    ]
  }
}