Workers

List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name

GET /api/{spaceId}/workers

Also reachable at /api/spaces/{spaceIdentifier}/workers, /api/workers.

Path Parameters

spaceId string (required)
The ID of the space containing the resource(s).

Query Parameters

commStyles array of string
List of communication styles which if specified, filters the result to only include Workers with matching communication styles.
healthStatuses array of string
List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.
ids array of string
List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.
isDisabled boolean
A filter to return only disabled/enabled Workers.
name string
The exact name of a Worker to be matched.
operatingSystemNames array of string
List of operating system names which if specified, filters the result to only include Workers with matching operating systems.
partialName string
A partial or complete name to search on. This will perform a “contains” style match against the supplied name or name-fragment.
shellNames array of string
List of shell names which if specified, filters the result to only include Workers with matching shells.
skip integer
Number of items to skip. Defaults to zero. Minimum 0.
take integer
Number of items to take. Defaults to 30. Minimum 0.
workerPoolIds array of string
List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.

Response

200 — A paginated list of Workers

Id string
Gets or sets a unique identifier for this resource.
ItemType string
Items array of object
- Architecture string
- Endpoint object
- HasLatestCalamari boolean
- HealthStatus enum
  Allowed values: Healthy, Unavailable, Unknown, HasWarnings, Unhealthy.
- Id string
  Gets or sets a unique identifier for this resource.
- IsDisabled boolean
- IsInProcess boolean
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- MachinePolicyId string
- Name string
- OperatingSystem string
- OperatingSystemVersion string
- ShellName string
- ShellVersion string
- SkipInitialHealthCheck boolean
- Slug string
- SpaceId string
- StatusSummary string
- Thumbprint string
- Uri string
- WorkerPoolIds array of string
ItemsPerPage integer
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LastPageNumber integer
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
NumberOfPages integer
TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "Architecture": "string",
      "Endpoint": {
        "CommunicationStyle": "None",
        "Id": "string",
        "LastModifiedBy": "string",
        "LastModifiedOn": "2020-01-01T00:00:00.000Z",
        "Links": {}
      },
      "HasLatestCalamari": true,
      "HealthStatus": "Healthy",
      "Id": "string",
      "IsDisabled": true,
      "IsInProcess": true,
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "MachinePolicyId": "string",
      "Name": "string",
      "OperatingSystem": "string",
      "OperatingSystemVersion": "string",
      "ShellName": "string",
      "ShellVersion": "string",
      "SkipInitialHealthCheck": true,
      "Slug": "string",
      "SpaceId": "string",
      "StatusSummary": "string",
      "Thumbprint": "string",
      "Uri": "string",
      "WorkerPoolIds": [
        "string"
      ]
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

Create a new worker

POST /api/{spaceId}/workers

Also reachable at /api/spaces/{spaceIdentifier}/workers, /api/workers.

Path Parameters

spaceId string (required)
The ID of the space containing the resource(s).

Request Body

Endpoint object (required)
- CommunicationStyle enum
  This is for legacy support in client. Server no longer uses this for determining endpoint types, it uses DeploymentTargetType.
  Allowed values: None, TentaclePassive, TentacleActive, Ssh, OfflineDrop, AzureWebApp, Ftp, AzureCloudService, AzureServiceFabricCluster, Kubernetes, StepPackage, KubernetesTentacle, AwsEcsCluster.
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
IsDisabled boolean (required)
Whether the worker is disabled or not.
MachinePolicyId string
The policy the worker must adhere to.
Name string (required)
The name of the worker. Minimum length 1.
SkipInitialHealthCheck boolean
Slug string
SpaceId string (required)
The ID of the space containing the resource(s).
WorkerPoolIds array of string (required)
The worker pools the worker belongs to.

Response

201 — Created

Architecture string
Endpoint object
- CommunicationStyle enum
  This is for legacy support in client. Server no longer uses this for determining endpoint types, it uses DeploymentTargetType.
  Allowed values: None, TentaclePassive, TentacleActive, Ssh, OfflineDrop, AzureWebApp, Ftp, AzureCloudService, AzureServiceFabricCluster, Kubernetes, StepPackage, KubernetesTentacle, AwsEcsCluster.
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
HasLatestCalamari boolean
HealthStatus enum
Allowed values: Healthy, Unavailable, Unknown, HasWarnings, Unhealthy.
Id string
Gets or sets a unique identifier for this resource.
IsDisabled boolean
IsInProcess boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
MachinePolicyId string
Name string
OperatingSystem string
OperatingSystemVersion string
ShellName string
ShellVersion string
SkipInitialHealthCheck boolean
Slug string
SpaceId string
StatusSummary string
Thumbprint string
Uri string
WorkerPoolIds array of string

{
  "Endpoint": {
    "CommunicationStyle": "None",
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "IsDisabled": true,
  "MachinePolicyId": "string",
  "Name": "string",
  "SkipInitialHealthCheck": true,
  "Slug": "string",
  "SpaceId": "string",
  "WorkerPoolIds": [
    "string"
  ]
}

{
  "Architecture": "string",
  "Endpoint": {
    "CommunicationStyle": "None",
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "HasLatestCalamari": true,
  "HealthStatus": "Healthy",
  "Id": "string",
  "IsDisabled": true,
  "IsInProcess": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "MachinePolicyId": "string",
  "Name": "string",
  "OperatingSystem": "string",
  "OperatingSystemVersion": "string",
  "ShellName": "string",
  "ShellVersion": "string",
  "SkipInitialHealthCheck": true,
  "Slug": "string",
  "SpaceId": "string",
  "StatusSummary": "string",
  "Thumbprint": "string",
  "Uri": "string",
  "WorkerPoolIds": [
    "string"
  ]
}

Get a list of Workers

GET /api/{spaceId}/workers/all

Also reachable at /api/spaces/{spaceIdentifier}/workers/all, /api/workers/all.

Lists all of the Workers in the supplied Space. The results will be sorted alphabetically by name.

Path Parameters

spaceId string (required)
The ID of the space containing the resource(s).

Query Parameters

ids array of string
A list of Worker resource IDs used to filter a query.
thumbprint string
A thumbprint used to filter a query.

Response

200 — The requested list of Workers

Architecture string
Endpoint object
- CommunicationStyle enum
  This is for legacy support in client. Server no longer uses this for determining endpoint types, it uses DeploymentTargetType.
  Allowed values: None, TentaclePassive, TentacleActive, Ssh, OfflineDrop, AzureWebApp, Ftp, AzureCloudService, AzureServiceFabricCluster, Kubernetes, StepPackage, KubernetesTentacle, AwsEcsCluster.
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
HasLatestCalamari boolean
HealthStatus enum
Allowed values: Healthy, Unavailable, Unknown, HasWarnings, Unhealthy.
Id string
Gets or sets a unique identifier for this resource.
IsDisabled boolean
IsInProcess boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
MachinePolicyId string
Name string
OperatingSystem string
OperatingSystemVersion string
ShellName string
ShellVersion string
SkipInitialHealthCheck boolean
Slug string
SpaceId string
StatusSummary string
Thumbprint string
Uri string
WorkerPoolIds array of string

[
  {
    "Architecture": "string",
    "Endpoint": {
      "CommunicationStyle": "None",
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    },
    "HasLatestCalamari": true,
    "HealthStatus": "Healthy",
    "Id": "string",
    "IsDisabled": true,
    "IsInProcess": true,
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "MachinePolicyId": "string",
    "Name": "string",
    "OperatingSystem": "string",
    "OperatingSystemVersion": "string",
    "ShellName": "string",
    "ShellVersion": "string",
    "SkipInitialHealthCheck": true,
    "Slug": "string",
    "SpaceId": "string",
    "StatusSummary": "string",
    "Thumbprint": "string",
    "Uri": "string",
    "WorkerPoolIds": [
      "string"
    ]
  }
]

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

GET /api/{spaceId}/workers/discover

Also reachable at /api/spaces/{spaceIdentifier}/workers/discover, /api/workers/discover.

Path Parameters

spaceId string (required)
The ID of the space containing the resource(s).

Query Parameters

host string (required)
The hostname of the machine to discover.
port integer
The port of the machine to discover.
proxyId string
The ID of the proxy to go through.
type enum
The type of endpoint on the machine.
Allowed values: TentaclePassive, TentacleActive, Ssh.

Response

200 — The worker which was discovered

Architecture string
Endpoint object
- CommunicationStyle enum
  This is for legacy support in client. Server no longer uses this for determining endpoint types, it uses DeploymentTargetType.
  Allowed values: None, TentaclePassive, TentacleActive, Ssh, OfflineDrop, AzureWebApp, Ftp, AzureCloudService, AzureServiceFabricCluster, Kubernetes, StepPackage, KubernetesTentacle, AwsEcsCluster.
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
HasLatestCalamari boolean
HealthStatus enum
Allowed values: Healthy, Unavailable, Unknown, HasWarnings, Unhealthy.
Id string
Gets or sets a unique identifier for this resource.
IsDisabled boolean
IsInProcess boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
MachinePolicyId string
Name string
OperatingSystem string
OperatingSystemVersion string
ShellName string
ShellVersion string
SkipInitialHealthCheck boolean
Slug string
SpaceId string
StatusSummary string
Thumbprint string
Uri string
WorkerPoolIds array of string

{
  "Architecture": "string",
  "Endpoint": {
    "CommunicationStyle": "None",
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "HasLatestCalamari": true,
  "HealthStatus": "Healthy",
  "Id": "string",
  "IsDisabled": true,
  "IsInProcess": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "MachinePolicyId": "string",
  "Name": "string",
  "OperatingSystem": "string",
  "OperatingSystemVersion": "string",
  "ShellName": "string",
  "ShellVersion": "string",
  "SkipInitialHealthCheck": true,
  "Slug": "string",
  "SpaceId": "string",
  "StatusSummary": "string",
  "Thumbprint": "string",
  "Uri": "string",
  "WorkerPoolIds": [
    "string"
  ]
}

Get all operating system names for workers. The result will be a string array

GET /api/{spaceId}/workers/operatingsystem/names/all

Also reachable at /api/spaces/{spaceIdentifier}/workers/operatingsystem/names/all, /api/workers/operatingsystem/names/all.

Path Parameters

spaceId string (required)

Response

200 — The operating system names for workers.

[
  "string"
]

Get all operating system shell names for workers. The result will be a string array

GET /api/{spaceId}/workers/operatingsystem/shells/all

Also reachable at /api/spaces/{spaceIdentifier}/workers/operatingsystem/shells/all, /api/workers/operatingsystem/shells/all.

Path Parameters

spaceId string (required)

Response

200 — The operating system shell names for workers.

[
  "string"
]

List all of the registered worker machines in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name

GET /api/{spaceId}/workers/v2

Also reachable at /api/spaces/{spaceIdentifier}/workers/v2, /api/workers/v2.

Path Parameters

spaceId string (required)

Query Parameters

commStyles array of string
List of communication styles which if specified, filters the result to only include Workers with matching communication styles.
healthStatuses array of string
List of health statuses which if specified, filters the result to only include Workers with matching health statuses.
ids array of string
List of Worker IDs which if specified, filters the result to only include Workers with matching IDs.
isDisabled boolean
A filter to return only disabled/enabled Workers.
name string
The exact name of a Worker to be matched.
operatingSystemNames array of string
List of operating system names which if specified, filters the result to only include Workers with matching operating systems.
partialName string
A partial or complete name to search on. This will perform a “contains” style match against the supplied name or name-fragment.
shellNames array of string
List of shell names which if specified, filters the result to only include Workers with matching shells.
skip integer
Number of items to skip. Defaults to zero. Minimum 0.
take integer
Number of items to take. Defaults to 30. Minimum 0.
workerPoolIds array of string
List of Worker Pool IDs which if specified, filters the result to only include Workers belonging to these Worker Pools.

Response

200 — The list of alphabetically sorted workers that matched the request.

WorkerCountPerHealthStatus object
Workers object
- ItemType string
- Items array of object
- ItemsPerPage integer
- LastPageNumber integer
- NumberOfPages integer
- TotalResults integer

{
  "WorkerCountPerHealthStatus": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "Workers": {
    "ItemType": "string",
    "Items": [
      {
        "Architecture": "string",
        "Endpoint": {},
        "HasLatestCalamari": true,
        "HealthStatus": "Healthy",
        "Id": "string",
        "IsDisabled": true,
        "IsInProcess": true,
        "LastModifiedBy": "string",
        "LastModifiedOn": "2020-01-01T00:00:00.000Z",
        "Links": {},
        "MachinePolicyId": "string",
        "Name": "string",
        "OperatingSystem": "string",
        "OperatingSystemVersion": "string",
        "ShellName": "string",
        "ShellVersion": "string",
        "SkipInitialHealthCheck": true,
        "Slug": "string",
        "SpaceId": "string",
        "StatusSummary": "string",
        "Thumbprint": "string",
        "Uri": "string",
        "WorkerPoolIds": [
          "string"
        ]
      }
    ],
    "ItemsPerPage": 0,
    "LastPageNumber": 0,
    "NumberOfPages": 0,
    "TotalResults": 0
  }
}

Get a Worker by ID

GET /api/{spaceId}/workers/{id}

Also reachable at /api/spaces/{spaceIdentifier}/workers/{id}, /api/workers/{id}.

Path Parameters

id string (required)
The ID of the Worker to retrieve.
spaceId string (required)
The ID of the space containing the resource(s).

Response

200 — Return the Worker Resource

Architecture string
Endpoint object
- CommunicationStyle enum
  This is for legacy support in client. Server no longer uses this for determining endpoint types, it uses DeploymentTargetType.
  Allowed values: None, TentaclePassive, TentacleActive, Ssh, OfflineDrop, AzureWebApp, Ftp, AzureCloudService, AzureServiceFabricCluster, Kubernetes, StepPackage, KubernetesTentacle, AwsEcsCluster.
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
HasLatestCalamari boolean
HealthStatus enum
Allowed values: Healthy, Unavailable, Unknown, HasWarnings, Unhealthy.
Id string
Gets or sets a unique identifier for this resource.
IsDisabled boolean
IsInProcess boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
MachinePolicyId string
Name string
OperatingSystem string
OperatingSystemVersion string
ShellName string
ShellVersion string
SkipInitialHealthCheck boolean
Slug string
SpaceId string
StatusSummary string
Thumbprint string
Uri string
WorkerPoolIds array of string

{
  "Architecture": "string",
  "Endpoint": {
    "CommunicationStyle": "None",
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "HasLatestCalamari": true,
  "HealthStatus": "Healthy",
  "Id": "string",
  "IsDisabled": true,
  "IsInProcess": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "MachinePolicyId": "string",
  "Name": "string",
  "OperatingSystem": "string",
  "OperatingSystemVersion": "string",
  "ShellName": "string",
  "ShellVersion": "string",
  "SkipInitialHealthCheck": true,
  "Slug": "string",
  "SpaceId": "string",
  "StatusSummary": "string",
  "Thumbprint": "string",
  "Uri": "string",
  "WorkerPoolIds": [
    "string"
  ]
}

Modify an existing worker machine

PUT /api/{spaceId}/workers/{id}

Also reachable at /api/spaces/{spaceIdentifier}/workers/{id}, /api/workers/{id}.

Path Parameters

id string (required)
The ID of the worker.
spaceId string (required)
The ID of the space containing the resource(s).

Request Body

Endpoint object (required)
- CommunicationStyle enum
  This is for legacy support in client. Server no longer uses this for determining endpoint types, it uses DeploymentTargetType.
  Allowed values: None, TentaclePassive, TentacleActive, Ssh, OfflineDrop, AzureWebApp, Ftp, AzureCloudService, AzureServiceFabricCluster, Kubernetes, StepPackage, KubernetesTentacle, AwsEcsCluster.
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Id string (required)
The ID of the worker.
IsDisabled boolean (required)
Whether the worker is disabled or not.
MachinePolicyId string
The policy the worker must adhere to.
Name string (required)
The name of the worker. Minimum length 1.
Slug string
SpaceId string (required)
The ID of the space containing the resource(s).
WorkerPoolIds array of string (required)
The worker pools the worker belongs to.

Response

200 — The modified worker

Architecture string
Endpoint object
- CommunicationStyle enum
  This is for legacy support in client. Server no longer uses this for determining endpoint types, it uses DeploymentTargetType.
  Allowed values: None, TentaclePassive, TentacleActive, Ssh, OfflineDrop, AzureWebApp, Ftp, AzureCloudService, AzureServiceFabricCluster, Kubernetes, StepPackage, KubernetesTentacle, AwsEcsCluster.
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
HasLatestCalamari boolean
HealthStatus enum
Allowed values: Healthy, Unavailable, Unknown, HasWarnings, Unhealthy.
Id string
Gets or sets a unique identifier for this resource.
IsDisabled boolean
IsInProcess boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
MachinePolicyId string
Name string
OperatingSystem string
OperatingSystemVersion string
ShellName string
ShellVersion string
SkipInitialHealthCheck boolean
Slug string
SpaceId string
StatusSummary string
Thumbprint string
Uri string
WorkerPoolIds array of string

{
  "Endpoint": {
    "CommunicationStyle": "None",
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "Id": "string",
  "IsDisabled": true,
  "MachinePolicyId": "string",
  "Name": "string",
  "Slug": "string",
  "SpaceId": "string",
  "WorkerPoolIds": [
    "string"
  ]
}

{
  "Architecture": "string",
  "Endpoint": {
    "CommunicationStyle": "None",
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  },
  "HasLatestCalamari": true,
  "HealthStatus": "Healthy",
  "Id": "string",
  "IsDisabled": true,
  "IsInProcess": true,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "MachinePolicyId": "string",
  "Name": "string",
  "OperatingSystem": "string",
  "OperatingSystemVersion": "string",
  "ShellName": "string",
  "ShellVersion": "string",
  "SkipInitialHealthCheck": true,
  "Slug": "string",
  "SpaceId": "string",
  "StatusSummary": "string",
  "Thumbprint": "string",
  "Uri": "string",
  "WorkerPoolIds": [
    "string"
  ]
}

Delete an existing Worker

DELETE /api/{spaceId}/workers/{id}

Also reachable at /api/spaces/{spaceIdentifier}/workers/{id}, /api/workers/{id}.

Path Parameters

id string (required)
The ID of the Worker to delete.
spaceId string (required)
The ID of the space containing the resource(s).

Response

200 — Success

Get the status of the network connection between the Octopus server and a worker

GET /api/{spaceId}/workers/{id}/connection

Also reachable at /api/spaces/{spaceIdentifier}/workers/{id}/connection, /api/workers/{id}/connection.

Path Parameters

id string (required)
The ID of the worker.
spaceId string (required)
The ID of the space containing the resource(s).

Response

200 — The connection status of the worker

CurrentTentacleVersion string
Id string
Gets or sets a unique identifier for this resource.
LastChecked string
Format date-time.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Logs array of object
- Category string
- Detail string
- GapLastNumber integer
- MessageText string
- Number integer
- OccurredAt string
  Format date-time.
MachineId string
Status string

{
  "CurrentTentacleVersion": "string",
  "Id": "string",
  "LastChecked": "2020-01-01T00:00:00.000Z",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Logs": [
    {
      "Category": "string",
      "Detail": "string",
      "GapLastNumber": 0,
      "MessageText": "string",
      "Number": 0,
      "OccurredAt": "2020-01-01T00:00:00.000Z"
    }
  ],
  "MachineId": "string",
  "Status": "string"
}