Hanzo
OpenapiO11y

Is the deployed agent's check-in on its original hyphenated path, kept for…

Is the deployed agent's check-in on its original hyphenated path, kept for backward compatibility with agents already running.

POST /v1/o11y/cloud-integrations/{cloud_provider}/agent-check-in

Addresshttps://api.hanzo.ai/v1/o11y/cloud-integrations/{cloud_provider}/agent-check-in
MethodPOST
OperationAgentCheckInDeprecated
AuthAuthorization: Bearer $HANZO_API_KEY

Is the deployed agent's check-in on its original hyphenated path, kept for backward compatibility with agents already running. Viewer gate — the agent's role is viewer.

Request

7 fields, body application/json (required).

FieldInTypeRequiredDescription
cloud_providerpathstringyes
account_idbodystring
cloud_account_idbodystring
cloudIntegrationIdbodyany
databodyobject
data.*bodyobject
providerAccountIdbodystring

Response

StatusBodyMeaning
200o11y.O11yAgentCheckInOutok

200 body — 46 fields.

FieldInTypeAlwaysDescription
databodyo11y.GettableAgentCheckIn
data.account_idbodystringOlder fields for backward compatibility with existing AWS agents
data.cloud_account_idbodystring
data.cloudIntegrationIdbodystring
data.integration_configbodyo11y.IntegrationConfig
data.integration_config.enabled_regionsbodystring[]backward compatible
data.integration_config.telemetrybodyo11y.OldAWSCollectionStrategy
data.integration_config.telemetry.aws_logsbodyo11y.OldAWSLogsStrategy
data.integration_config.telemetry.aws_logs.cloudwatch_logs_subscriptionsbodyobject[]
data.integration_config.telemetry.aws_logs.cloudwatch_logs_subscriptions[].filter_patternbodystring
data.integration_config.telemetry.aws_logs.cloudwatch_logs_subscriptions[].log_group_name_prefixbodystring
data.integration_config.telemetry.aws_metricsbodyo11y.OldAWSMetricsStrategy
data.integration_config.telemetry.aws_metrics.cloudwatch_metric_stream_filtersbodyobject[]
data.integration_config.telemetry.aws_metrics.cloudwatch_metric_stream_filters[].MetricNamesbodystring[]
data.integration_config.telemetry.aws_metrics.cloudwatch_metric_stream_filters[].Namespacebodystring
data.integration_config.telemetry.providerbodystring
data.integration_config.telemetry.s3_bucketsbodyobject
data.integration_config.telemetry.s3_buckets.*bodystring[]
data.integrationConfigbodyo11y.ProviderIntegrationConfig
data.integrationConfig.awsbodyo11y.AWSIntegrationConfig
data.integrationConfig.aws.enabledRegionsbodystring[]
data.integrationConfig.aws.telemetryCollectionStrategybodyo11y.AWSTelemetryCollectionStrategy
data.integrationConfig.aws.telemetryCollectionStrategy.logsbodyo11y.AWSLogsCollectionStrategy
data.integrationConfig.aws.telemetryCollectionStrategy.logs.subscriptionsbodyo11y.AWSCloudWatchLogsSubscription[]
data.integrationConfig.aws.telemetryCollectionStrategy.logs.subscriptions[].filterPatternbodystringhttps://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html "" implies no filtering is required
data.integrationConfig.aws.telemetryCollectionStrategy.logs.subscriptions[].logGroupNamePrefixbodystringsubscribe to all logs groups with specified prefix.
data.integrationConfig.aws.telemetryCollectionStrategy.metricsbodyo11y.AWSMetricsCollectionStrategy
data.integrationConfig.aws.telemetryCollectionStrategy.metrics.streamFiltersbodyo11y.AWSCloudWatchMetricStreamFilter[]to be used as https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includefilter…
data.integrationConfig.aws.telemetryCollectionStrategy.metrics.streamFilters[].metricNamesbodystring[]
data.integrationConfig.aws.telemetryCollectionStrategy.metrics.streamFilters[].namespacebodystringhttps://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html
data.integrationConfig.aws.telemetryCollectionStrategy.s3BucketsbodyobjectOnly available in S3 Sync Service Type in AWS
data.integrationConfig.aws.telemetryCollectionStrategy.s3Buckets.*bodystring[]
data.integrationConfig.azurebodyo11y.AzureIntegrationConfig
data.integrationConfig.azure.deploymentRegionbodystring
data.integrationConfig.azure.resourceGroupsbodystring[]
data.integrationConfig.azure.telemetryCollectionStrategybodyo11y.AzureTelemetryCollectionStrategy[]
data.integrationConfig.azure.telemetryCollectionStrategy[].logsbodyo11y.AzureLogsCollectionStrategy
data.integrationConfig.azure.telemetryCollectionStrategy[].logs.categoryGroupsbodystring[]List of categories to enable for diagnostic settings, to start with it will have 'allLogs' and no filtering.
data.integrationConfig.azure.telemetryCollectionStrategy[].metricsbodyo11y.AzureMetricsCollectionStrategy
data.integrationConfig.azure.telemetryCollectionStrategy[].resourceProviderbodystringhttps://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types
data.integrationConfig.azure.telemetryCollectionStrategy[].resourceTypebodystring
data.integrationConfig.gcpbodyo11y.GCPIntegrationConfig
data.providerAccountIdbodystring
data.removed_atbodystring (date-time)
data.removedAtbodystring (date-time)
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y cloud-integrations agent-check-in <cloud_provider>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page