---
title: System Information REST Endpoints
slug: a0Gq6dPrARSykOnNkgy4U
description: Access system information in Ocient through REST endpoints, ideal for monitoring and automation.
docTags: 
createdAt: Thu Jul 21 2022 17:05:13 GMT+0000 (Coordinated Universal Time)
updatedAt: Mon Mar 30 2026 18:52:45 GMT+0000 (Coordinated Universal Time)
---

The Ocient Data Intelligence Platform™ maintains many internal statistics. You can access the statistics on each node in the database using a REST interface that listens on port 9090 by default. For an overview of monitoring statistics, see [Statistics Monitoring](<./Statistics Monitoring.md>).

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "http://oc1-lts0:9090/v1/stats",
  "name": "Get Statistics",
  "method": "GET",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [
      {
        "kind": "optional",
        "name": "filter",
        "type": "string",
        "description": "Filter for the statistics."
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "Shm4EZ6m3dDX41EXW_17t",
        "code": "[{\n  \"name\": \"vm.stats.pdfCacheSize\",\n  \"time\": \"1686335017884363\",\n  \"timestamp\": \"2023-06-09T18:23:37.884Z\",\n  \"node\": \"sql0\",\n  \"value\": 4680936\n},\n{\n    \"name\": \"localStorageService.device.spaceFree\",\n    \"time\": \"1686335145388588\",\n    \"timestamp\": \"2023-06-09T18:25:45.388Z\",\n    \"node\": \"sql0\",\n    \"value\": 0,\n    \"device\": \"4418fbc3-fcf9-5cfe-b2b3-b41a8247a600\"\n  }\n]",
        "language": "200",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "Shm4EZ6m3dDX41EXW_17t"
  },
  "examples": {
    "languages": [
      {
        "id": "jiYZR0yNoLBqcSUzMZsPV",
        "code": "curl --location --request GET 'http://oc1-lts0:9090/v1/stats' \\\n--header 'Accept: application/json' ",
        "language": "curl",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "jiYZR0yNoLBqcSUzMZsPV"
  },
  "description": "Retrieve the statistics on each node in the database.",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false
}
```
:::

:::hint{type="info"}
These fields appear in every entry returned in the response from the `http://oc1-lts0:9090/v1/stats` endpoint:

- `name`
- `time`
- `timestamp`
- `node`
- `value`

Additional fields can vary.
:::

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "http://oc1-lts0:9090/v1/version",
  "name": "Get Version",
  "method": "GET",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "MK_gl2s5goAFNvEfJMvll",
        "code": "{\n    \"version\": \"24.0.0\",\n    \"timestamp\": \"20231110.212417\",\n    \"git_commit\": \"178ba7a7549bd40c137035c5cd4f10c55fd31b00\",\n    \"build_user\": \"\",\n    \"build_type\": \"DEBUG\",\n    \"build_flags\": \"fb,lld_flags,mcmodel_medium,tls_model_initial_exec\"\n}",
        "language": "200",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "MK_gl2s5goAFNvEfJMvll"
  },
  "examples": {
    "languages": [
      {
        "id": "r-2pLZKYatSV50bClGCC1",
        "code": "curl --location --request GET 'http://oc1-lts0:9090/v1/version' \\\n--header 'Accept: application/json'",
        "language": "curl",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "r-2pLZKYatSV50bClGCC1"
  },
  "description": "Retrieve the version of the software running.",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false
}
```
:::

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "http://oc1-lts0:9090/v1/status",
  "name": "Get Status",
  "method": "GET",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "YucwQbiAWCsqXiJrvUpzm",
        "code": "Active",
        "language": "200",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "YucwQbiAWCsqXiJrvUpzm"
  },
  "examples": {
    "languages": [
      {
        "id": "Td6Bpv8WHi_eVhaX_oUs7",
        "code": "curl --location --request GET 'http://oc1-lts0:9090/v1/status' \\\n--header 'Accept: application/json'",
        "language": "curl",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "Td6Bpv8WHi_eVhaX_oUs7"
  },
  "description": "Retrieve the status of the software running.",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false
}
```
:::

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "http://oc1-lts0:9090/v1/sysconfig",
  "name": "Get Configuration",
  "method": "GET",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "4XRkAfOFiQQ9q5xEkwNQ8",
        "code": "{\n  \"system_name\": \"abc7d45f-1e9c-4210-811d-ffg6dbd82297\",\n  \"node_name\": \"sql0\",\n  \"node_uuid\": \"578c11a2-1996-523f-a371-c393b4e5ff2e\",\n  \"hostname\": \"username-dev0\",\n  \"roles\": [\n    \"administration\",\n    \"health\",\n    \"vm\",\n    \"cmdComp\"\n  ],\n  \"failed_roles\": [],\n  \"endpoints\": [\n    {\n      \"name\": \"adminopenendpoint\",\n      \"address\": \"localhost\",\n      \"port\": 19000\n    },\n    {\n      \"name\": \"restendpoint\",\n      \"address\": \"localhost\",\n      \"port\": 8000\n    },\n    {\n      \"name\": \"adminsecureendpoint\",\n      \"address\": \"localhost\",\n      \"port\": 18500\n    },\n    {\n      \"name\": \"dataendpoint\",\n      \"address\": \"localhost\",\n      \"port\": 16500\n    },\n    {\n      \"name\": \"sqlexternal\",\n      \"address\": \"localhost\",\n      \"port\": 3070\n    }\n  ],\n  \"totalram\": 450948103168,\n  \"processors\": 120,\n  \"hugepages\": [\n    {\n      \"size\": 1257152,\n      \"total\": 0,\n      \"free\": 0,\n      \"reserved\": 0\n    },\n    {\n      \"size\": 1060041824,\n      \"total\": 0,\n      \"free\": 0,\n      \"reserved\": 0\n    }\n  ],\n  \"storage_devices\": [\n    {\n      \"id\": \"4425fad3-fcf9-5cfd-f3b3-b47a8457a300\",\n      \"address\": \"/address/4425fad3-fcf9-5cfd-f3b3-b47a8457a300.dat\",\n      \"type\": \"SATA\",\n      \"use\": \"PAYLOAD\",\n      \"pci_address\": \"\",\n      \"mount_point\": \"\",\n      \"device_path\": \"\"\n    },\n    {\n      \"id\": \"9ae82aa7-ab73-5g86-bb34-13b27945c701\",\n      \"address\": \"/address/9ae82aa7-ab73-5g86-bb34-13b27945c701.dat\",\n      \"type\": \"SATA\",\n      \"use\": \"PAYLOAD\",\n      \"pci_address\": \"\",\n      \"mount_point\": \"\",\n      \"device_path\": \"\"\n    }\n  ],\n  \"connections\": [\n    {\n      \"address\": \"111.1.1.1\",\n      \"remote_port\": 45598,\n      \"state\": \"connected\",\n      \"locally_initiated\": false\n    }\n  ]\n}",
        "language": "200",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "4XRkAfOFiQQ9q5xEkwNQ8"
  },
  "examples": {
    "languages": [
      {
        "id": "LWLiH1bXFSKJkLFuB7yFO",
        "code": "curl --location --request GET 'http://oc1-lts0:9090/v1/sysconfig' \\\n--header 'Accept: application/json'",
        "language": "curl",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "LWLiH1bXFSKJkLFuB7yFO"
  },
  "description": "Retrieve the configuration about this node in JSON format.",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false
}
```
:::

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "http://oc1-lts0:9090/v1/dbconfig",
  "name": "Get Configuration of Whole System",
  "method": "GET",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "TyRQBdBSctuz2RlpdCCnE",
        "code": "{\n  \"system_name\": \"abc7d45f-1e9c-4210-811d-ffg6dbd82297\",\n  \"node_name\": \"sql0\",\n  \"node_uuid\": \"578c11a2-1996-523f-a371-c393b4e5ff2e\",\n  \"hostname\": \"username-dev0\",\n  \"roles\": [\n    \"administration\",\n    \"health\",\n    \"vm\",\n    \"cmdComp\"\n  ],\n  \"failed_roles\": [],\n  \"endpoints\": [\n    {\n          \"name\": \"adminopenendpoint\",\n          \"type\": \"FULL\",\n          \"address\": \"localhost\",\n          \"port\": 18000\n    },\n    {\n      \"name\": \"restendpoint\",\n      \"type\": \"FULL\",\n      \"address\": \"localhost\",\n      \"port\": 8000\n    },\n    {\n      \"name\": \"adminsecureendpoint\",\n      \"type\": \"FULL\",\n      \"address\": \"localhost\",\n      \"port\": 18500\n    },\n    {\n      \"name\": \"dataendpoint\",\n      \"type\": \"FULL\",\n      \"address\": \"localhost\",\n      \"port\": 16500\n    },\n    {\n      \"name\": \"sqlexternal\",\n      \"type\": \"FULL\",\n      \"address\": \"localhost\",\n      \"port\": 3070\n    }\n  ],\n  \"totalram\": 450948103168,\n  \"processors\": 120,\n  \"hugepages\": [\n    {\n      \"size\": 1257152,\n      \"total\": 0,\n      \"free\": 0,\n      \"reserved\": 0\n    },\n    {\n      \"size\": 1060041824,\n      \"total\": 0,\n      \"free\": 0,\n      \"reserved\": 0\n    }\n  ],\n  \"storage_devices\": [\n    {\n      \"id\": \"4425fad3-fcf9-5cfd-f3b3-b47a8457a300\",\n      \"address\": \"/address/4425fad3-fcf9-5cfd-f3b3-b47a8457a300.dat\",\n      \"type\": \"SATA\",\n      \"use\": \"PAYLOAD\",\n      \"pci_address\": \"\",\n      \"mount_point\": \"\",\n      \"device_path\": \"\"\n    },\n    {\n      \"id\": \"9ae82aa7-ab73-5g86-bb34-13b27945c701\",\n      \"address\": \"/address/9ae82aa7-ab73-5g86-bb34-13b27945c701.dat\",\n      \"type\": \"SATA\",\n      \"use\": \"PAYLOAD\",\n      \"pci_address\": \"\",\n      \"mount_point\": \"\",\n      \"device_path\": \"\"\n    }\n  ],\n  \"connections\": [\n    {\n      \"address\": \"111.1.1.1\",\n      \"remote_port\": 45598,\n      \"state\": \"connected\",\n      \"locally_initiated\": false\n    }\n  ]\n}",
        "language": "200",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "TyRQBdBSctuz2RlpdCCnE"
  },
  "examples": {
    "languages": [
      {
        "id": "63GJxJbM6NkGa05SQYV4i",
        "code": "curl --location --request GET 'http://oc1-lts0:9090/v1/dbconfig' \\\n--header 'Accept: application/json' \\\n--data-raw '{\"filter\":\"string\"}'",
        "language": "curl",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "63GJxJbM6NkGa05SQYV4i"
  },
  "description": "Retrieve the configuration of the system as a whole in JSON format.",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false
}
```
:::

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "http://oc1-lts0:9090/v1/config",
  "name": "Get Configuration Parameters",
  "method": "GET",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "nAY5vTv7iibFEI9UuoToB",
        "code": "{\n  \"siloType\": \"xg::runtime::physicalSiloSet_t\",\n  \"tlbfsInfo.enabled\": \"false\",\n  \"tlbfsInfo.mountPoint\": \"/mnt/name/hugepages1G\",\n  \"tlbfsInfo.hugePageSize\": \"1073741824\",\n  \"tlbfsInfo.hugePageCount\": \"512\",\n  \"memory.warningHpMemoryUsageRatio\": \"0.80000000000000004\",\n  \"memory.preferredHpMemoryUsageRatio\": \"0.94999999999999996\",\n  \"memory.warningHeapMemoryUsageRatio\": \"0.90000000000000002\",\n  \"silos.numSilos\": \"2\",\n  \"silos.coreSets.computeCoreMask\": \"0b111111111111000\",\n  \"silos.coreSets.ioCoreMask\": \"0b1000000111100000\",\n  \"silos.coreSets.networkCoreMask\": \"0b10000000000111100\",\n  \"silos.coreSets.generalCoreMask\": \"0b100000000000000111\",\n  \"gdsClientParameters_t.batchTimer\": \"150000000n\",\n  \"gdsClientParameters_t.maxBatchCount\": \"4096\",\n  \"ports.adminsecure\": \"18500\",\n  \"ports.data\": \"16500\",\n  \"ports.hsi\": \"16900\",\n  \"ports.ingress\": \"15300\",\n  \"ports.rest\": \"8000\",\n  \"ports.sql\": \"3070\",\n  \"ports.adminopen\": \"18000\"\n  \"operatorvm.vmProtocolParameters.vmClusterRaftFileParameters.fileName\": \"sql0-vmCluster.raft\"\n}",
        "language": "200",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "nAY5vTv7iibFEI9UuoToB"
  },
  "examples": {
    "languages": [
      {
        "id": "F0Trc2C_Fc_flVCjXjNQb",
        "code": "curl --location --request GET 'http://oc1-lts0:9090/v1/config' \\\n--header 'Accept: application/json'",
        "language": "curl",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "F0Trc2C_Fc_flVCjXjNQb"
  },
  "description": "Retrieve values of configuration parameters.",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false
}
```
:::

