Ctrlk
ProductPricingSign inRequest a Demo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Agent Versions

List agent versions

get
Responses
200

OK

application/json
get/agent-versions
GET /v1/agent-versions HTTP/1.1
Accept: */*

{
  "agentVersions": [
    {
      "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": {
        "containerImages": [
          {
            "image": "text"
          }
        ],
        "download": {
          "ANY_ADDITIONAL_PROPERTY": {
            "hash": "text",
            "url": "text"
          }
        },
        "draft": true,
        "installer": {
          "ANY_ADDITIONAL_PROPERTY": {
            "url": "text"
          }
        },
        "prerelease": true,
        "releaseDate": "text",
        "releaseNotesURL": "text",
        "type": "text",
        "version": "text"
      },
      "status": {}
    }
  ]
}

List agent versions with supplemental information

get
Responses
200

OK

application/json
get/agent-versions/detailed
GET /v1/agent-versions/detailed HTTP/1.1
Accept: */*

{
  "agentVersions": [
    {
      "agentTypeDisplayName": "text",
      "agentVersion": {
        "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": {
          "containerImages": [
            {
              "image": "text"
            }
          ],
          "download": {
            "ANY_ADDITIONAL_PROPERTY": {
              "hash": "text",
              "url": "text"
            }
          },
          "draft": true,
          "installer": {
            "ANY_ADDITIONAL_PROPERTY": {
              "url": "text"
            }
          },
          "prerelease": true,
          "releaseDate": "text",
          "releaseNotesURL": "text",
          "type": "text",
          "version": "text"
        },
        "status": {}
      },
      "availableComponents": {
        "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": {
          "components": {
            "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
          },
          "hash": "text"
        },
        "status": {}
      }
    }
  ]
}

Get Install Command

get

Get the proper install command for the provided parameters.

Path parameters
typestringRequired

observiq-otel-collector

versionstringRequired

2.1.1

Query parameters
secret-keystringOptional

uuid

remote-urlstringOptional

http%3A%2F%2Flocalhost%3A3001

platformstringOptional

windows-amd64

labelsstringOptional

env=stage,app=bindplane,configuration=my-config,fleet=my-fleet

Responses
200

OK

application/json
alternateCommandstringOptional
commandstringOptional
versionstringOptional
get/agent-versions/{type}/{version}/install-command
GET /v1/agent-versions/{type}/{version}/install-command HTTP/1.1
Accept: */*

{
  "alternateCommand": "text",
  "command": "text",
  "version": "text"
}

Sync Agent Version

post

Create an agent-version from the contents of a github release.

Path parameters
versionstringRequired

2.1.1

Responses
202

Accepted

application/json
post/agent-versions/{type}/{version}/sync
POST /v1/agent-versions/{type}/{version}/sync HTTP/1.1
Accept: */*

{
  "updates": [
    {
      "before": null,
      "reason": "string",
      "resource": null,
      "status": "error"
    }
  ]
}

Get Kubernetes Operator bridge manifest

get

Returns the OpAMP bridge manifest YAML to apply as the final manual install step

Query parameters
configurationstringRequired

operator configuration name

secret-keystringOptional

uuid

remote-urlstringOptional

http%3A%2F%2Flocalhost%3A3001

Responses
200

OK

application/json
alternateCommandstringOptional
commandstringOptional
versionstringOptional
get/kubernetes-operator/install-command
GET /v1/kubernetes-operator/install-command?configuration=text HTTP/1.1
Accept: */*

{
  "alternateCommand": "text",
  "command": "text",
  "version": "text"
}
PreviousAgent Version
NextNotifications

Last updated

Was this helpful?