API - Finding All Avaliable Properties for a Built in Action

MattHodge · 1 July 2018 07:24

Hello,

I’m trying to create deployment steps from the API. (The goal is to make a Terraform Resource for Octopus Deploy)

I can get a list of the built-in Octopus Deploy Action Templates at api/actiontemplates/search

From there, is there any way from the API I can see what the Step properties are for the built-in ActionTypes?

I would need these for all ActionTypes so I can model them in the Terraform resource.

Thanks,

Matt

Daniel_Fischer · 4 July 2018 06:55

Hi Matt,

Thanks for getting in touch! Unfortunately this information is not available via the API. However, I can provide you with a link to our Calamari open source code which has a categorised list with the majority of available Properties.

github.com

OctopusDeploy/Calamari/blob/master/source/Calamari.Shared/Deployment/SpecialVariables.cs

namespace Calamari.Deployment
{
    public static class SpecialVariables
    {
        public const string LastErrorMessage = "OctopusLastErrorMessage";
        public const string LastError = "OctopusLastError";

        public static readonly string AppliedXmlConfigTransforms = "OctopusAppliedXmlConfigTransforms";

        public static string GetLibraryScriptModuleName(string variableName)
        {
            return variableName.Replace("Octopus.Script.Module[", "").TrimEnd(']');
        }

        public static bool IsExcludedFromLocalVariables(string name)
        {
            return name.Contains("[");
        }

        public static bool IsLibraryScriptModule(string variableName)

This file has been truncated. show original

I think this is the closest we have to what you are after so I’m hoping it helps you out here.

If you have any thoughts or questions here, please let me know and I’ll do my best to help.

Best regards,
Daniel

MattHodge · 5 July 2018 18:32

Hi Daneil,

This will help keep me going for a while

Definitely will make my resource a more complicated as the Octopus UI does a ton of heavy lifting that I cannot see for step creation ;/

Let’s see how I go!

If you are interested:

Still under HEAVY development.

Matt

Daniel_Fischer · 6 July 2018 01:13

Hi Matt,

Thanks for the update, I’m glad I was able to help out a bit here.

Please feel free to get in touch at any time.

Best regards,

system · 5 August 2018 01:13

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