ONoneuptime
Cloud Resource

Get Cloud Resource

Endpoint to retrieve a single Cloud Resource by ID

post/cloud-resource/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Cloud Resource to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "resourceIdentifier": true,
    "cloudPlatform": true,
    "cloudProvider": true,
    "cloudRegion": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "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"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "AWS ECS · us-east-1 · 123456789012",
    "slug": "example-slug-value",
    "description": "This is an example of longer text content that might be stored in this field.",
    "resourceIdentifier": "Example short text",
    "cloudPlatform": "Example short text",
    "cloudProvider": "Example short text",
    "cloudRegion": "Example short text",
    "cloudAccountId": "Example short text",
    "cloudResourceKind": "resource",
    "cloudResourceType": "Microsoft.Compute/virtualMachines",
    "providerResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-prod/providers/Microsoft.Compute/virtualMachines/vm-prod-01",
    "cloudResourceGroup": "rg-prod",
    "telemetryAttributes": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "cloudTags": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "cloudProperties": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "cloudRelationships": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "cloudEndpoints": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "inventoriedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "cloudReadings": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "cloudReadingsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "healthSeverity": "Example short text",
    "cloudConnectionId": "123e4567-e89b-12d3-a456-426614174000",
    "runtimeName": "Example short text",
    "runtimeVersion": "Example short text",
    "otelCollectorStatus": "Example short text",
    "agentVersion": "Example short text",
    "lastSeenAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "retainTelemetryDataForDays": 42,
    "telemetryRetentionConfig": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "isArchived": true,
    "archivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "autoArchivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

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