Rapid7 · Schema

PageMetadata2

SecurityVulnerability ManagementSIEMXDRCloud SecuritySOARApplication Security

Properties

Name Type Description
index integer The 0 based index of the page retrieved.
size integer The size of the page requested.
total_pages integer The total number of pages available with the given filter parameters.
total_data integer The total number of results available with the given filter parameters.
View JSON Schema on GitHub

JSON Schema

rapid7-pagemetadata2-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PageMetadata2",
  "title": "PageMetadata2",
  "type": "object",
  "properties": {
    "index": {
      "type": "integer",
      "format": "int32",
      "description": "The 0 based index of the page retrieved.",
      "example": 0
    },
    "size": {
      "type": "integer",
      "format": "int32",
      "description": "The size of the page requested.",
      "example": 20
    },
    "total_pages": {
      "type": "integer",
      "format": "int32",
      "description": "The total number of pages available with the given filter parameters.",
      "example": 1
    },
    "total_data": {
      "type": "integer",
      "format": "int64",
      "description": "The total number of results available with the given filter parameters.",
      "example": 15
    }
  },
  "required": [
    "index",
    "size",
    "total_data",
    "total_pages"
  ]
}