Licenses

Get the status of the current Octopus license.

Calculates the status of the current Octopus license including compliance and maintenance expiry.

get/licenses/licenses-current-status

Request

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

Response

The requested License Status

ComplianceSummarystring
DaysToEffectiveExpiryDateinteger
DoesExpiryBlockKeyActivitiesboolean
EffectiveClusterTaskLimitinteger
EffectiveExpiryDatestring
EffectiveNodeTaskLimitinteger
EffectiveStartDatestring
HostingEnvironmentstring
Idstring

Gets or sets a unique identifier for this resource.

IsClusterTaskLimitControlledByLicenseboolean
IsCompliantboolean
IsInitialisationLicenseboolean
IsNodeTaskLimitControlledByLicenseboolean
IsPtmboolean
IsTrialboolean
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.

PermissionsMode'Unspecified' | 'Restricted' | 'Full'
SerialNumberstring

Example response

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

Changes

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