Postman · JSON Structure

Postman Monitor Structure

JSON Structure for a Postman Monitor managed by the Monitors API.

Type: object Properties: 1 Required: 1

AI Agent BuilderAI AgentsAPI CatalogAPI ClientAPI DesignAPI DevelopmentAPI DocumentationAPI GovernanceAPI LifecycleAPI MonitoringAPI NetworkAPI PlatformAPI TestingAudit LogsAutomationCI/CDCollaborationCollectionsComplianceDiscoveryEnvironmentsFlowsGraphQLgRPCHTTPInsightsMCPMCP GeneratorMock ServersMockingMonitorsNewmanOpenAPIPlatformPrivate API NetworkPublic API NetworkSecret ScanningSpec HubSpecificationsSSOTestingVaultWebSocketWorkflowsWorkspaces

Postman Monitor Structure is a JSON Structure definition published by Postman, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/draft-2025/structure meta-schema.

Properties

monitor

Meta-schema: https://json-structure.org/draft-2025/structure

JSON Structure

{
  "$schema": "https://json-structure.org/draft-2025/structure",
  "title": "PostmanMonitor",
  "description": "JSON Structure for a Postman Monitor managed by the Monitors API.",
  "type": "object",
  "required": ["monitor"],
  "properties": {
    "monitor": {
      "type": "object",
      "required": ["id", "name", "uid", "collection"],
      "properties": {
        "id": { "type": "string", "format": "uuid" },
        "uid": { "type": "string" },
        "name": { "type": "string" },
        "owner": { "type": "string" },
        "collection": { "type": "string", "description": "Collection UID being executed." },
        "environment": { "type": "string", "description": "Environment UID applied to runs." },
        "schedule": {
          "type": "object",
          "required": ["cron", "timezone"],
          "properties": {
            "cron": { "type": "string", "description": "Cron expression for the schedule." },
            "timezone": { "type": "string" },
            "nextRun": { "type": "string", "format": "date-time" }
          }
        },
        "notifications": {
          "type": "object",
          "properties": {
            "onError": { "type": "array", "items": { "type": "object" } },
            "onFailure": { "type": "array", "items": { "type": "object" } }
          }
        },
        "distribution": { "type": "array", "items": { "type": "string" } },
        "lastRun": {
          "type": "object",
          "properties": {
            "status": { "type": "string", "enum": ["success", "failed", "aborted"] },
            "startedAt": { "type": "string", "format": "date-time" },
            "finishedAt": { "type": "string", "format": "date-time" },
            "stats": {
              "type": "object",
              "properties": {
                "assertions": { "type": "object" },
                "requests": { "type": "object" }
              }
            }
          }
        }
      }
    }
  }
}