API Documentation - details for arguments

pazza98 · 7 January 2019 10:27

I’m interested in invoking the health check of tentacles via the REST API and I’m following the guide from @Dalmiro for doing this. I’ve looked at the documentation via swaggerui, but I can’t see what arguments are available to me, except in his example where he uses the timeout and environment as arguments. I’d like to be able to invoke the health check by different filters for tentacles, e.g. environment or project etc. but would prefer to be able to work this out for myself by checking the documentation for available arguments etc. Thanks.

Kenneth_Bates · 8 January 2019 01:12

Hi Will,

Thanks for getting in touch! Are you referring to the sample script provided by Dalmiro at the following link?

github.com

OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Targets/CheckHealthOfSpecificTargets.ps1

Add-Type -Path "" # Path to Newtonsoft.Json.dll 
Add-Type -Path "" # Path to Octopus.Client.dll 

$OctopusURL = "" 
$OctopusAPIKey = "" 
$MachineName = "" #Machine Display Name 

$endpoint = new-object Octopus.Client.OctopusServerEndpoint $OctopusURL,$OctopusAPIKey 
$repository = new-object Octopus.Client.OctopusRepository $endpoint 
$findmachine = $repository.Machines.FindByName("$MachineName") 
$machineid = $findmachine.id

$header = @{ "X-Octopus-ApiKey" = $OctopusAPIKey }

$body = @{ 
    Name = "Health" 
    Description = "Checking health of $MachineName" 
    Arguments = @{ 
        Timeout= "00:05:00" 
        MachineIds = @($machineId) #$MachinID could contain an array of machines too

This file has been truncated. show original

In the network tab in your browser console, you can see the API call that’s made when performing tasks like health checks in the web portal. Besides Timeout and MachineIds, the only other argument present is OnlyTestConnection.

I hope this helps get you going! Let me know if you have any further questions or concerns moving forward.

Best regards,

Kenny

system · 7 February 2019 01:12

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.