Workers

Interrogate a machine for communication details so that it may be added to the installation.

get/workers/discover

Request

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

Query parameters

hoststring required

The hostname of the machine to discover

portinteger

The port of the machine to discover

proxyIdstring

The ID of the proxy to go through

type'TentaclePassive' | 'TentacleActive' | 'Ssh'

The type of endpoint on the machine

Response

The worker which was discovered

Architecturestring
HasLatestCalamariboolean
HealthStatus'Healthy' | 'Unavailable' | 'Unknown' | 'HasWarnings' | 'Unhealthy'
Idstring

Gets or sets a unique identifier for this resource.

IsDisabledboolean
IsInProcessboolean
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.

MachinePolicyIdstring
Namestring
OperatingSystemstring
OperatingSystemVersionstring
ShellNamestring
ShellVersionstring
SkipInitialHealthCheckboolean
Slugstring
SpaceIdstring
StatusSummarystring
Thumbprintstring
Uristring
WorkerPoolIdsstring[]

Example response

{
  "Endpoint": {
    "Links": {
      "Self": "/api/..."
    }
  },
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1",
  "WorkerPoolIds": [
    "WorkerPools-1",
    "..."
  ]
}

Changes

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