{
  "opencollection": "1.0.0",
  "info": {
    "name": "NVIDIA Run:ai Access Keys Nodes API",
    "version": "latest"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Nodes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a list of nodes.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/clusters/:clusterUuid/nodes",
            "params": [
              {
                "name": "clusterUuid",
                "value": "",
                "type": "path",
                "description": "The Universally Unique Identifier (UUID) of the cluster."
              },
              {
                "name": "nodeName",
                "value": "",
                "type": "query",
                "description": "Deprecated - use filterBy instead. The node name; Cannot be used together with filterBy, sort, offset, limit or search query params."
              },
              {
                "name": "filterBy",
                "value": "",
                "type": "query",
                "description": "Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort results by a parameters."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort results in descending or ascending order."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset of the first item returned in the collection."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of entries to return."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Filter results by a free text search."
              }
            ]
          },
          "docs": "Retrieve a list of nodes from the Kubernetes cluster. Deprecated - use `/api/v1/nodes` instead."
        },
        {
          "info": {
            "name": "Count nodes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/clusters/:clusterUuid/nodes/count",
            "params": [
              {
                "name": "clusterUuid",
                "value": "",
                "type": "path",
                "description": "The Universally Unique Identifier (UUID) of the cluster."
              },
              {
                "name": "filterBy",
                "value": "",
                "type": "query",
                "description": "Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Filter results by a free text search."
              }
            ]
          },
          "docs": "Count nodes"
        },
        {
          "info": {
            "name": "Get a list of nodes.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/nodes",
            "params": [
              {
                "name": "filterBy",
                "value": "",
                "type": "query",
                "description": "Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort results by a parameters."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort results in descending or ascending order."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset of the first item returned in the collection."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of entries to return."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Filter results by a free text search."
              }
            ]
          },
          "docs": "Retrieve a list of nodes from all the Kubernetes clusters of the tenant."
        },
        {
          "info": {
            "name": "Count tenant nodes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/nodes/count",
            "params": [
              {
                "name": "filterBy",
                "value": "",
                "type": "query",
                "description": "Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Filter results by a free text search."
              }
            ]
          },
          "docs": "Count nodes from all the Kubernetes clusters of the tenant."
        },
        {
          "info": {
            "name": "Get node telemetry data.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/nodes/telemetry",
            "params": [
              {
                "name": "clusterId",
                "value": "",
                "type": "query",
                "description": "Filter using the Universally Unique Identifier (UUID) of the cluster."
              },
              {
                "name": "nodepoolName",
                "value": "",
                "type": "query",
                "description": "Filter using the nodepool."
              },
              {
                "name": "groupBy",
                "value": "",
                "type": "query",
                "description": "workload fields to group the data by"
              },
              {
                "name": "telemetryType",
                "value": "",
                "type": "query",
                "description": "specifies what data to request"
              }
            ]
          },
          "docs": "Retrieve node telemetry data for use in analysis applications."
        },
        {
          "info": {
            "name": "Get the node metrics data.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/nodes/:nodeId/metrics",
            "params": [
              {
                "name": "nodeId",
                "value": "",
                "type": "path",
                "description": "The node UUID."
              },
              {
                "name": "metricType",
                "value": "",
                "type": "query",
                "description": "Specify which data to request."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Start date of time range to fetch data in ISO 8601 timestamp format."
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "End date of time range to fetch data in ISO 8601 timestamp format."
              },
              {
                "name": "numberOfSamples",
                "value": "",
                "type": "query",
                "description": "The number of samples to take in the specified time range."
              }
            ]
          },
          "docs": "Retrieve the node metrics data by Universally Unique Identifier (UUID)."
        }
      ]
    }
  ],
  "bundled": true
}