Observability

Register and trusts new Kubernetes Monitor.

post/{spaceId}/observability/agents

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/observability/agents
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdstring required

Request body

InstallationIdstring uuid required

Installation ID of that uniquely identifies the physical installation of the agent.

MachineIdstring required

Machine ID of that uniquely identifies the deployment target or worker that is being observed

PreserveAuthenticationTokenboolean

Controls whether the authentication token should be preserved during re-registration. If not supplied (null), the token will be regenerated (default behavior). If false, the token will be regenerated. If true, the existing token will be preserved.

SpaceIdstring required

Example request

{
  "MachineId": "Machines-1",
  "SpaceId": "Spaces-1"
}

Response

Response containing the registered agent.

AuthenticationTokenstring

Authentication token for the monitor. Will be null if PreserveAuthenticationToken was set to true in the request and not registering a new monitor

CertificateThumbprintstring required

Example response

{
  "Resource": {
    "Id": "KubernetesMonitors-1",
    "MachineId": "Machines-1",
    "SpaceId": "Spaces-1"
  }
}

Changes

No recorded changes to this operation across all 13 revisions of this API.