Update Cloud Integration

Update Cloud Integration

Update a specific cloud integration

Request
URI
PUT
https://{api_host}/api/v2/cloudintegration/{id}
COPY
Path Parameters
string
id
Required

id


Request Body
CloudIntegration of type(s) application/json
Optional
{
    "forceSave": false,
    "reuseExternalIdCredential": "string",
    "name": "string",
    "id": "string",
    "service": "string",
    "lastReceivedDataPointMs": 0,
    "lastMetricCount": 0,
    "cloudWatch": {
        "namespaces": [
            "string"
        ],
        "metricFilterRegex": "^aws.(billing|instance|sqs|sns|reservedInstance|ebs|route53.health|ec2.status|elb).*$",
        "baseCredentials": {
            "roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
            "externalId": "string"
        },
        "instanceSelectionTagsExpr": "string",
        "volumeSelectionTagsExpr": "string",
        "pointTagFilterRegex": "(region|name)",
        "s3BucketNameFilterRegex": "^(test|demo).*$",
        "threadDistributionInMins": 0
    },
    "cloudTrail": {
        "region": "string",
        "prefix": "string",
        "bucketName": "string",
        "baseCredentials": {
            "roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
            "externalId": "string"
        },
        "filterRule": "string"
    },
    "ec2": {
        "metricFilterRegex": "^aws.(sqs|ebs).*$",
        "baseCredentials": {
            "roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
            "externalId": "string"
        },
        "hostNameTags": [
            "string"
        ],
        "instanceSelectionTagsExpr": "string",
        "volumeSelectionTagsExpr": "string",
        "pointTagFilterRegex": "(region|name)"
    },
    "gcp": {
        "metricFilterRegex": "^gcp.(compute|container|pubsub).*$",
        "projectId": "string",
        "gcpJsonKey": "string",
        "disableHistogramToMetricConversion": false,
        "disableDeltaCounts": false,
        "categoriesToFetch": [
            "string"
        ],
        "customMetricPrefix": [
            "string"
        ]
    },
    "gcpBilling": {
        "projectId": "string",
        "gcpJsonKey": "string",
        "gcpApiKey": "string"
    },
    "newRelic": {
        "apiKey": "string",
        "appFilterRegex": "^hostingservice-(prod|dev)*$",
        "hostFilterRegex": "host[1-9].xyz.com",
        "newRelicMetricFilters": [
            {
                "appName": "string",
                "metricFilterRegex": "string"
            }
        ]
    },
    "appDynamics": {
        "userName": "user1@account1",
        "controllerName": "string",
        "encryptedPassword": "string",
        "enableRollup": false,
        "enableErrorMetrics": false,
        "enableBusinessTrxMetrics": false,
        "enableBackendMetrics": false,
        "enableOverallPerfMetrics": false,
        "enableIndividualNodeMetrics": false,
        "enableAppInfraMetrics": false,
        "enableServiceEndpointMetrics": false,
        "appFilterRegex": [
            "string"
        ]
    },
    "dynatrace": {
        "metricFilterRegex": "^dynatrace.(builtin|dsfm).*$",
        "environmentID": "example",
        "dynatraceAPIToken": "string"
    },
    "azure": {
        "metricFilterRegex": "^azure.(compute|network|dbforpostgresql).*$",
        "baseCredentials": {
            "clientId": "string",
            "clientSecret": "string",
            "tenant": "string"
        },
        "categoryFilter": [
            "string"
        ],
        "resourceGroupFilter": [
            "string"
        ]
    },
    "azureActivityLog": {
        "baseCredentials": {
            "clientId": "string",
            "clientSecret": "string",
            "tenant": "string"
        },
        "categoryFilter": [
            "string"
        ]
    },
    "lastErrorMs": 0,
    "lastProcessorId": "string",
    "lastProcessingTimestamp": 0,
    "createdEpochMillis": 0,
    "updatedEpochMillis": 0,
    "serviceRefreshRateInMins": 0,
    "vrops": {
        "baseURL": "https://www.mgmt.cloud.vmware.com/vrops-cloud",
        "metricFilterRegex": "^vrops.(vmware|cloudhealthadapter).(clustercomputeresource|datastore).*$",
        "categoriesToFetch": [
            "string"
        ],
        "vropsAPIToken": "string",
        "organizationID": "string"
    },
    "disabled": false,
    "lastError": "string",
    "deleted": false,
    "inTrash": false,
    "lastErrorEvent": {
        "computedHlps": [
            {
                "severity": "string",
                "host": "string",
                "startTime": 0,
                "label": "string",
                "observed": 0,
                "firing": 0
            }
        ],
        "table": "string",
        "name": "string",
        "id": "string",
        "startTime": 0,
        "endTime": 0,
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "tags": [
            "string"
        ],
        "metricsUsed": [
            "string"
        ],
        "createdAt": 0,
        "hosts": [
            "string"
        ],
        "summarizedEvents": 0,
        "alertTags": [
            "string"
        ],
        "isUserEvent": false,
        "isEphemeral": false,
        "creatorId": "string",
        "updaterId": "string",
        "updatedAt": 0,
        "runningState": "string",
        "canDelete": false,
        "canClose": false,
        "creatorType": [
            "string"
        ]
    },
    "creatorId": "string",
    "updaterId": "string",
    "snowflake": {
        "userName": "string",
        "password": "string",
        "metricFilterRegex": "string",
        "privateKey": "string",
        "role": "string",
        "accountID": "string",
        "warehouse": "string"
    }
}
boolean
forceSave
Optional

forceSave

string
reuseExternalIdCredential
Optional

reuseExternalIdCredential

string
name
Required

The human-readable name of this integration

string
id
Optional

id

string
service
Required

A value denoting which cloud service this integration integrates with

Possible values are : CLOUDWATCH, CLOUDTRAIL, EC2, GCP, GCPBILLING, AZURE, AZUREACTIVITYLOG, NEWRELIC, APPDYNAMICS, VROPS, SNOWFLAKE, DYNATRACE,
object
additionalTags
Optional

A list of point tag key-values to add to every point ingested using this integration

integer As int64 As int64
lastReceivedDataPointMs
Optional

Time that this integration last received a data point, in epoch millis

integer As int64 As int64
lastMetricCount
Optional

Number of metrics / events ingested by this integration the last time it ran

cloudWatch
Optional

cloudWatch

cloudTrail
Optional

cloudTrail

ec2
Optional

ec2

gcp
Optional

gcp

gcpBilling
Optional

gcpBilling

newRelic
Optional

newRelic

appDynamics
Optional

appDynamics

dynatrace
Optional

dynatrace

azure
Optional

azure

azureActivityLog
Optional

azureActivityLog

integer As int64 As int64
lastErrorMs
Optional

Time, in epoch millis, of the last error encountered by Wavefront servers when fetching data using this integration

string
lastProcessorId
Optional

Opaque id of the last Wavefront integrations service to act on this integration

integer As int64 As int64
lastProcessingTimestamp
Optional

Time, in epoch millis, that this integration was last processed

integer As int64 As int64
createdEpochMillis
Optional

createdEpochMillis

integer As int64 As int64
updatedEpochMillis
Optional

updatedEpochMillis

integer As int32 As int32
serviceRefreshRateInMins
Optional

Service refresh rate in minutes.

vrops
Optional

vrops

boolean
disabled
Optional

True when an aws credential failed to authenticate.

string
lastError
Optional

Digest of the last error encountered by Wavefront servers when fetching data using this integration

boolean
deleted
Optional

deleted

boolean
inTrash
Optional

inTrash

lastErrorEvent
Optional

lastErrorEvent

string
creatorId
Optional

creatorId

string
updaterId
Optional

updaterId

snowflake
Optional

snowflake

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResponseContainerCloudIntegration of type(s) application/json
{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "forceSave": false,
        "reuseExternalIdCredential": "string",
        "name": "string",
        "id": "string",
        "service": "string",
        "lastReceivedDataPointMs": 0,
        "lastMetricCount": 0,
        "cloudWatch": {
            "namespaces": [
                "string"
            ],
            "metricFilterRegex": "^aws.(billing|instance|sqs|sns|reservedInstance|ebs|route53.health|ec2.status|elb).*$",
            "baseCredentials": {
                "roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
                "externalId": "string"
            },
            "instanceSelectionTagsExpr": "string",
            "volumeSelectionTagsExpr": "string",
            "pointTagFilterRegex": "(region|name)",
            "s3BucketNameFilterRegex": "^(test|demo).*$",
            "threadDistributionInMins": 0
        },
        "cloudTrail": {
            "region": "string",
            "prefix": "string",
            "bucketName": "string",
            "baseCredentials": {
                "roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
                "externalId": "string"
            },
            "filterRule": "string"
        },
        "ec2": {
            "metricFilterRegex": "^aws.(sqs|ebs).*$",
            "baseCredentials": {
                "roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
                "externalId": "string"
            },
            "hostNameTags": [
                "string"
            ],
            "instanceSelectionTagsExpr": "string",
            "volumeSelectionTagsExpr": "string",
            "pointTagFilterRegex": "(region|name)"
        },
        "gcp": {
            "metricFilterRegex": "^gcp.(compute|container|pubsub).*$",
            "projectId": "string",
            "gcpJsonKey": "string",
            "disableHistogramToMetricConversion": false,
            "disableDeltaCounts": false,
            "categoriesToFetch": [
                "string"
            ],
            "customMetricPrefix": [
                "string"
            ]
        },
        "gcpBilling": {
            "projectId": "string",
            "gcpJsonKey": "string",
            "gcpApiKey": "string"
        },
        "newRelic": {
            "apiKey": "string",
            "appFilterRegex": "^hostingservice-(prod|dev)*$",
            "hostFilterRegex": "host[1-9].xyz.com",
            "newRelicMetricFilters": [
                {
                    "appName": "string",
                    "metricFilterRegex": "string"
                }
            ]
        },
        "appDynamics": {
            "userName": "user1@account1",
            "controllerName": "string",
            "encryptedPassword": "string",
            "enableRollup": false,
            "enableErrorMetrics": false,
            "enableBusinessTrxMetrics": false,
            "enableBackendMetrics": false,
            "enableOverallPerfMetrics": false,
            "enableIndividualNodeMetrics": false,
            "enableAppInfraMetrics": false,
            "enableServiceEndpointMetrics": false,
            "appFilterRegex": [
                "string"
            ]
        },
        "dynatrace": {
            "metricFilterRegex": "^dynatrace.(builtin|dsfm).*$",
            "environmentID": "example",
            "dynatraceAPIToken": "string"
        },
        "azure": {
            "metricFilterRegex": "^azure.(compute|network|dbforpostgresql).*$",
            "baseCredentials": {
                "clientId": "string",
                "clientSecret": "string",
                "tenant": "string"
            },
            "categoryFilter": [
                "string"
            ],
            "resourceGroupFilter": [
                "string"
            ]
        },
        "azureActivityLog": {
            "baseCredentials": {
                "clientId": "string",
                "clientSecret": "string",
                "tenant": "string"
            },
            "categoryFilter": [
                "string"
            ]
        },
        "lastErrorMs": 0,
        "lastProcessorId": "string",
        "lastProcessingTimestamp": 0,
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "serviceRefreshRateInMins": 0,
        "vrops": {
            "baseURL": "https://www.mgmt.cloud.vmware.com/vrops-cloud",
            "metricFilterRegex": "^vrops.(vmware|cloudhealthadapter).(clustercomputeresource|datastore).*$",
            "categoriesToFetch": [
                "string"
            ],
            "vropsAPIToken": "string",
            "organizationID": "string"
        },
        "disabled": false,
        "lastError": "string",
        "deleted": false,
        "inTrash": false,
        "lastErrorEvent": {
            "computedHlps": [
                {
                    "severity": "string",
                    "host": "string",
                    "startTime": 0,
                    "label": "string",
                    "observed": 0,
                    "firing": 0
                }
            ],
            "table": "string",
            "name": "string",
            "id": "string",
            "startTime": 0,
            "endTime": 0,
            "createdEpochMillis": 0,
            "updatedEpochMillis": 0,
            "tags": [
                "string"
            ],
            "metricsUsed": [
                "string"
            ],
            "createdAt": 0,
            "hosts": [
                "string"
            ],
            "summarizedEvents": 0,
            "alertTags": [
                "string"
            ],
            "isUserEvent": false,
            "isEphemeral": false,
            "creatorId": "string",
            "updaterId": "string",
            "updatedAt": 0,
            "runningState": "string",
            "canDelete": false,
            "canClose": false,
            "creatorType": [
                "string"
            ]
        },
        "creatorId": "string",
        "updaterId": "string",
        "snowflake": {
            "userName": "string",
            "password": "string",
            "metricFilterRegex": "string",
            "privateKey": "string",
            "role": "string",
            "accountID": "string",
            "warehouse": "string"
        }
    }
}
status
Required

status

response
Optional

response