ApiHostView_Atlas

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-api-host-view-atlas-schema.json",
  "title": "ApiHostView_Atlas",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-monitoring-and-logs-api-openapi.yml#/components/schemas/ApiHostView_Atlas",
  "properties": {
    "created": {
      "description": "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "groupId": {
      "description": "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.",
      "pattern": "^([a-f0-9]{24})$",
      "readOnly": true,
      "type": "string"
    },
    "hostname": {
      "description": "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).",
      "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.",
      "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$",
      "readOnly": true,
      "type": "string"
    },
    "lastPing": {
      "description": "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "links": {
      "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.",
      "items": {
        "$ref": "#/$defs/Link_Atlas"
      },
      "readOnly": true,
      "type": "array"
    },
    "port": {
      "description": "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "replicaSetName": {
      "description": "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.",
      "readOnly": true,
      "type": "string"
    },
    "shardName": {
      "description": "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.",
      "readOnly": true,
      "type": "string"
    },
    "typeName": {
      "description": "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as `NO_DATA` until MongoDB Cloud completes deploying the process.",
      "enum": [
        "REPLICA_PRIMARY",
        "REPLICA_SECONDARY",
        "RECOVERING",
        "SHARD_MONGOS",
        "SHARD_CONFIG",
        "SHARD_STANDALONE",
        "SHARD_PRIMARY",
        "SHARD_SECONDARY",
        "NO_DATA"
      ],
      "readOnly": true,
      "type": "string"
    },
    "userAlias": {
      "description": "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.",
      "readOnly": true,
      "type": "string"
    },
    "version": {
      "description": "Version of MongoDB that this process runs.",
      "pattern": "([\\d]+\\.[\\d]+\\.[\\d]+)",
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object",
  "$defs": {
    "Link_Atlas": {
      "properties": {
        "href": {
          "description": "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.",
          "type": "string"
        },
        "rel": {
          "description": "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}