create-adapter-instance

create-adapter-instance
create-adapter-instance

A DTO that serves as the structure of the payload data for creating a new adapter instance

JSON Example
{
    "name": "string",
    "description": "string",
    "collectorId": "string",
    "collectorGroupId": "string",
    "adapterKindKey": "string",
    "resourceIdentifiers": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "credential": {
        "id": "string",
        "name": "string",
        "adapterKindKey": "string",
        "credentialKindKey": "string",
        "fields": [
            {
                "name": "string",
                "value": "string"
            }
        ],
        "editable": false
    },
    "monitoringInterval": 0,
    "monitoringIntervalSeconds": 0,
    "physicalDatacenterId": "string"
}
string
name
Required
Constraints: minLength: 3 maxLength: 300

The name of the Adapter instance

string
description
Optional

Optional description of the Adapter instance

string
collectorId
Optional

The Collector instance used by this adapter instance. If not specified, the system will choose an appropriate Collector for you

string As uuid As uuid
collectorGroupId
Optional

The Collector Group ID to be used for this Adapter Instance. If not specified, the system will choose an appropriate Collector group for you

string
adapterKindKey
Required

The Adapter Kind key

array of name-value
resourceIdentifiers
Optional

Adapter instance specific resource identifiers

credential
credential
Optional

The Credential Instance information

integer As int32 As int32
monitoringInterval
Optional
Constraints: minimum: 0

Minutes part of the monitoring Interval of the Adapter Instance, where the monitoring Interval is the frequency of data source query for stats and properties.

integer As int32 As int32
monitoringIntervalSeconds
Optional
Constraints: minimum: 0

Seconds part of the monitoring Interval of the Adapter Instance, where the monitoring Interval is the frequency of data source query for stats and properties.

string As uuid As uuid
physicalDatacenterId
Optional

The Physical Datacenter ID to be used for this Adapter Instance. It is Optional

Parameter To