OCoctopus
Upgrade

Update the upgrade configuration used by the Octopus Server.

put/upgradeconfiguration

Request

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

Request body

AllowCheckingboolean required

Whether to check octopus.com to see if a new version is available.

IncludeStatisticsboolean required

Deprecated: please use the dedicated telemetry page to determine whether octopus sends usage statistics. See our documentation for information about what is included.

NotificationMode'AlwaysShow' | 'ShowOnlyMajorMinor' | 'NeverShow' required

Controls which notifications are shown in the portal when an upgrade is available.

Response

The updated upgrade configuration

AllowCheckingboolean

Whether to check octopus.com to see if a new version is available.

Idstring

Gets or sets a unique identifier for this resource.

IncludeStatisticsboolean

Deprecated: please use the [dedicated telemetry page](" + OctoLink.BaseAddress + "telemetry) to determine whether octopus sends usage statistics. See [our documentation](" + OctoLink.BaseAddress + "WhatIsIncludedInUsageStatistics) for information about what is included.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

NotificationMode'AlwaysShow' | 'ShowOnlyMajorMinor' | 'NeverShow'

Controls which notifications are shown in the portal when an upgrade is available.

Example response

{
  "Links": {
    "Self": "/api/..."
  }
}

Changes

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