Host

Create Host

Endpoint to create a new Host

post/host

Request

Request body

Example request

{
  "data": {
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "hostIdentifier": "Example Text"
  }
}

Response

Created successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "slug": "example-slug",
    "description": "This is an example of longer text content that provides detailed information.",
    "hostIdentifier": "Example Text",
    "otelCollectorStatus": "Example Text",
    "agentVersion": "Example Text",
    "lastSeenAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "osType": "Example Text",
    "osVersion": "This is an example of longer text content that provides detailed information.",
    "hostId": "Example Text",
    "hostArch": "Example Text",
    "hostType": "Example Text",
    "hostIpAddresses": "This is an example of longer text content that provides detailed information.",
    "cpuCores": 42,
    "totalMemoryBytes": 42,
    "processCount": 42,
    "containerRuntime": "Example Text",
    "dockerHost": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "dockerHostId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "kubernetesCluster": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "kubernetesClusterId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "proxmoxCluster": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "proxmoxClusterId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "openStackCloud": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "openStackCloudId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "isArchived": true,
    "archivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "archivedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "archivedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "deletedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "labels": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "retainTelemetryDataForDays": 42,
    "telemetryRetentionConfig": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "deploymentEnvironment": "Example Text",
    "runtimeName": "Example Text",
    "runtimeVersion": "Example Text",
    "cloudProvider": "Example Text",
    "cloudPlatform": "Example Text",
    "cloudRegion": "Example Text",
    "cloudAccountId": "Example Text",
    "isAiInvestigationEnabled": true,
    "aiRemediationMode": "Example Text",
    "aiCommandAllowlist": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "aiAccessLastVerifiedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "aiAccessLastError": "This is an example of longer text content that provides detailed information.",
    "aiAccessConfiguredAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "collectorInstanceUid": "Example Text",
    "collectorLastContactAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "collectorRegisteredAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "collectorConfig": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "collectorConfigId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "isCollectorConfigPinned": true,
    "collectorConfigVersion": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "collectorConfigVersionId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "collectorConfigHash": "Example Text",
    "collectorConfigStatus": "Example Text",
    "collectorConfigError": "This is an example of longer text content that provides detailed information.",
    "collectorFailedConfigHash": "Example Text",
    "isCollectorHealthy": true,
    "collectorHealthError": "This is an example of longer text content that provides detailed information.",
    "collectorHostFeatures": "Example Text",
    "latestCpuPercent": 42,
    "latestMemoryPercent": 42,
    "latestSwapPercent": 42,
    "latestDiskPercent": 42,
    "latestDiskMountpoint": "This is an example of longer text content that provides detailed information.",
    "latestInodesPercent": 42,
    "latestInodesMountpoint": "This is an example of longer text content that provides detailed information.",
    "latestLoadAverage15m": 42,
    "bootedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "failedSystemdUnitCount": 42,
    "failedSystemdUnits": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "readingsUpdatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.