Header | Postman Collection Format

Header

The header objects allows you to include HTTP headers in your requests.

Contents


Reference table

Field Name Type   Required Description
key string true The LHS of the HTTP header. For example, Content-Type or X-Custom-Header.
value string true The value or RHS of the header.
disabled boolean false If set to true, the current header won't be sent with requests.
description #description false The description of this header.

Reference diagram

Header Unit Image


Schema

{
  "type": "object",
  "title": "Header",
  "$id": "#/definitions/header",
  "description": "Represents a single HTTP Header",
  "properties": {
    "key": {
      "description": "This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``",
      "type": "string"
    },
    "value": {
      "type": "string",
      "description": "The value (or the RHS) of the Header is stored in this field."
    },
    "disabled": {
      "type": "boolean",
      "default": false,
      "description": "If set to true, the current header will not be sent with requests."
    },
    "description": {
      "$ref": "#/definitions/description"
    }
  },
  "required": [
    "key",
    "value"
  ]
}



For more information, see the complete schema.

Last modified: 2025/02/25