Configurations
Query parameters
querystringOptional
the query to filter configurations by, e.g. name:agent-1
selectorstringOptional
the selector to filter configurations by, e.g. configuration=my-config
offsetstringOptional
the pagination offset
limitstringOptional
the maximum number of results to return
Responses
200
OK
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /v1/configurations HTTP/1.1
Host:
Accept: */*
{
"configurations": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"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": {
"connectors": [
"[Circular Reference]"
],
"contentType": "text",
"destinations": [
"[Circular Reference]"
],
"disableLegacyEnvVarNormalization": true,
"extensions": [
"[Circular Reference]"
],
"measurementInterval": "text",
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"processors": [
"[Circular Reference]"
],
"raw": "text",
"rollout": {
"description": "text",
"disabled": true,
"displayName": "text",
"id": "text",
"licenseEnabled": true,
"name": "text",
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"processors": "[Circular Reference]",
"public": true,
"recommendation": "text",
"routes": {
"logs": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"traces": [
{
"components": [
"text"
],
"id": "text"
}
]
},
"secOpsPipelineName": "text",
"type": "text",
"version": "text"
},
"selector": {
"matchLabels": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"sources": [
"[Circular Reference]"
],
"topologyInterval": "text"
},
"status": {
"current": true,
"currentVersion": -2,
"latest": true,
"pending": true,
"pendingVersion": -2,
"rollout": {
"name": "text",
"options": {
"maxErrors": 1,
"phaseAgentCount": {
"initial": 1,
"maximum": 1,
"multiplier": 1
}
},
"phase": 1,
"progress": {
"completed": 1,
"errors": 1,
"incompatible": 1,
"pending": 1,
"waiting": 1
},
"stage": 1,
"stages": [
{
"labels": {},
"name": "text",
"progress": {
"completed": 1,
"errors": 1,
"incompatible": 1,
"pending": 1,
"waiting": 1
}
}
],
"startedAt": "text",
"status": 0
}
}
}
]
}Path parameters
namestringRequired
the name of the Configuration
Responses
200
OK
application/json
401
Unauthorized
application/json
404
Not Found
application/json
500
Internal Server Error
application/json
get
GET /v1/configurations/{name} HTTP/1.1
Host:
Accept: */*
{
"configuration": {
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"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": {
"connectors": [
{
"description": "text",
"disabled": true,
"displayName": "text",
"id": "text",
"licenseEnabled": true,
"name": "text",
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"processors": "[Circular Reference]",
"public": true,
"recommendation": "text",
"routes": {
"logs": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"traces": [
{
"components": [
"text"
],
"id": "text"
}
]
},
"secOpsPipelineName": "text",
"type": "text",
"version": "text"
}
],
"contentType": "text",
"destinations": [
{
"description": "text",
"disabled": true,
"displayName": "text",
"id": "text",
"licenseEnabled": true,
"name": "text",
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"processors": "[Circular Reference]",
"public": true,
"recommendation": "text",
"routes": {
"logs": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"traces": [
{
"components": [
"text"
],
"id": "text"
}
]
},
"secOpsPipelineName": "text",
"type": "text",
"version": "text"
}
],
"disableLegacyEnvVarNormalization": true,
"extensions": [
{
"description": "text",
"disabled": true,
"displayName": "text",
"id": "text",
"licenseEnabled": true,
"name": "text",
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"processors": "[Circular Reference]",
"public": true,
"recommendation": "text",
"routes": {
"logs": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"traces": [
{
"components": [
"text"
],
"id": "text"
}
]
},
"secOpsPipelineName": "text",
"type": "text",
"version": "text"
}
],
"measurementInterval": "text",
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"processors": [
{
"description": "text",
"disabled": true,
"displayName": "text",
"id": "text",
"licenseEnabled": true,
"name": "text",
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"processors": "[Circular Reference]",
"public": true,
"recommendation": "text",
"routes": {
"logs": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"traces": [
{
"components": [
"text"
],
"id": "text"
}
]
},
"secOpsPipelineName": "text",
"type": "text",
"version": "text"
}
],
"raw": "text",
"rollout": {
"description": "text",
"disabled": true,
"displayName": "text",
"id": "text",
"licenseEnabled": true,
"name": "text",
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"processors": [
"[Circular Reference]"
],
"public": true,
"recommendation": "text",
"routes": {
"logs": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"traces": [
{
"components": [
"text"
],
"id": "text"
}
]
},
"secOpsPipelineName": "text",
"type": "text",
"version": "text"
},
"selector": {
"matchLabels": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"sources": [
{
"description": "text",
"disabled": true,
"displayName": "text",
"id": "text",
"licenseEnabled": true,
"name": "text",
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"processors": "[Circular Reference]",
"public": true,
"recommendation": "text",
"routes": {
"logs": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"logs+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics": [
{
"components": [
"text"
],
"id": "text"
}
],
"metrics+traces": [
{
"components": [
"text"
],
"id": "text"
}
],
"traces": [
{
"components": [
"text"
],
"id": "text"
}
]
},
"secOpsPipelineName": "text",
"type": "text",
"version": "text"
}
],
"topologyInterval": "text"
},
"status": {
"current": true,
"currentVersion": -2,
"latest": true,
"pending": true,
"pendingVersion": -2,
"rollout": {
"name": "text",
"options": {
"maxErrors": 1,
"phaseAgentCount": {
"initial": 1,
"maximum": 1,
"multiplier": 1
}
},
"phase": 1,
"progress": {
"completed": 1,
"errors": 1,
"incompatible": 1,
"pending": 1,
"waiting": 1
},
"stage": 1,
"stages": [
{
"labels": {},
"name": "text",
"progress": {
"completed": 1,
"errors": 1,
"incompatible": 1,
"pending": 1,
"waiting": 1
}
}
],
"startedAt": "text",
"status": 0
}
}
},
"raw": "text"
}Path parameters
namestringRequired
the name of the configuration to delete
Responses
204
Successful Delete, no content
No content
401
Unauthorized
application/json
404
Not Found
application/json
500
Internal Server Error
application/json
delete
DELETE /v1/configurations/{name} HTTP/1.1
Host:
Accept: */*
No content
Path parameters
namestringRequired
the name of the configuration to duplicate
Body
stringOptional
Responses
201
Successful Copy, created
No content
401
Unauthorized
application/json
404
Not Found
application/json
409
Conflict
application/json
500
Internal Server Error
application/json
post
POST /v1/configurations/{name}/copy HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"No content
Path parameters
namestringRequired
the name of the configuration to revert
Responses
204
Successful Revert, no content
No content
401
Unauthorized
application/json
404
Not Found
application/json
409
The latest version cannot be reverted, i.e. it has been rolled out.
application/json
500
Internal Server Error
application/json
put
PUT /v1/configurations/{name}/revert HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?