Agent Versions

List agent versions

get
Responses
200

OK

application/json
get
GET /v1/agent-versions HTTP/1.1
Host: 
Accept: */*
{
  "agentVersions": [
    {
      "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": {
        "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": {}
    }
  ]
}

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

Responses
200

OK

application/json
get
GET /v1/agent-versions/{type}/{version}/install-command HTTP/1.1
Host: 
Accept: */*
{
  "alternateCommand": "text",
  "command": "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
POST /v1/agent-versions/{type}/{version}/sync HTTP/1.1
Host: 
Accept: */*
{
  "updates": [
    {
      "before": null,
      "reason": "string",
      "resource": null,
      "status": "error"
    }
  ]
}

Was this helpful?