Configuration Types
Last updated
Was this helpful?
Was this helpful?
GET /v1/configuration-types HTTP/1.1
Accept: */*
{
"configurationTypes": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"blueprintTags": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"featureGate": "text",
"logs": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"logs+metrics": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"logs+metrics+traces": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"logs+traces": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"metrics": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"metrics+traces": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"parameters": [
{
"advancedConfig": true,
"default": null,
"description": "text",
"documentation": [
{
"text": "text",
"url": "text"
}
],
"hidden": true,
"label": "text",
"name": "text",
"options": {
"code": true,
"contexts": [
"text"
],
"creatable": true,
"gridColumns": 1,
"horizontalDivider": true,
"labels": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"metricCategories": [
{
"column": 1,
"label": "text",
"metrics": [
{
"defaultDisabled": true,
"description": "text",
"kpi": true,
"name": "text"
}
]
}
],
"multiline": true,
"ottlContext": "text",
"ottlContextRef": "text",
"password": true,
"preventEmpty": true,
"processorContext": "text",
"saasOnly": true,
"sectionHeader": true,
"sensitive": true,
"sensitiveCompanion": "text",
"subHeader": "text",
"trackUnchecked": true,
"variant": "text"
},
"properties": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"relevantIf": [
{
"name": "text",
"operator": "text",
"value": null
}
],
"relevantIfOperator": "text",
"required": true,
"requiredIf": [
{
"name": "text",
"operator": "text",
"value": null
}
],
"requiredIfOperator": "text",
"type": "text",
"validValues": [
"text"
]
}
],
"supportedLicenseTypes": [
"text"
],
"supportedPlatforms": [
"text"
],
"traces": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"version": "text"
},
"status": {
"latest": true
}
}
]
}GET /v1/configuration-types/{name} HTTP/1.1
Accept: */*
{
"configurationType": {
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"blueprintTags": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"featureGate": "text",
"logs": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"logs+metrics": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"logs+metrics+traces": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"logs+traces": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"metrics": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"metrics+traces": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"parameters": [
{
"advancedConfig": true,
"default": null,
"description": "text",
"documentation": [
{
"text": "text",
"url": "text"
}
],
"hidden": true,
"label": "text",
"name": "text",
"options": {
"code": true,
"contexts": [
"text"
],
"creatable": true,
"gridColumns": 1,
"horizontalDivider": true,
"labels": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"metricCategories": [
{
"column": 1,
"label": "text",
"metrics": [
{
"defaultDisabled": true,
"description": "text",
"kpi": true,
"name": "text"
}
]
}
],
"multiline": true,
"ottlContext": "text",
"ottlContextRef": "text",
"password": true,
"preventEmpty": true,
"processorContext": "text",
"saasOnly": true,
"sectionHeader": true,
"sensitive": true,
"sensitiveCompanion": "text",
"subHeader": "text",
"trackUnchecked": true,
"variant": "text"
},
"properties": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"relevantIf": [
{
"name": "text",
"operator": "text",
"value": null
}
],
"relevantIfOperator": "text",
"required": true,
"requiredIf": [
{
"name": "text",
"operator": "text",
"value": null
}
],
"requiredIfOperator": "text",
"type": "text",
"validValues": [
"text"
]
}
],
"supportedLicenseTypes": [
"text"
],
"supportedPlatforms": [
"text"
],
"traces": {
"connectors": "text",
"emits": [
"metrics"
],
"exporters": "text",
"extensions": "text",
"processors": "text",
"receivers": "text",
"templates": [
{
"connectors": "text",
"deprecated": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"exporters": "text",
"extensions": "text",
"match": [
{
"component": "text",
"operator": ">=",
"version": "text"
}
],
"processors": "text",
"receivers": "text"
}
]
},
"version": "text"
},
"status": {
"latest": true
}
}
}