This is an early build of the site and information may not be accurate or complete.
Octopus Deploy

This collector collect deployments from an Octopus Deploy server.

Example

{
    "$schema": "https://duckhq.org/schema.json",
    "collectors": [
        {
            "octopus": {
                "id": "octopus_server",
                "serverUrl": "https://example.com:9000",
                "credentials": {
                    "apiKey": "OCTOPUS-API-KEY"
                },
                "projects": [
                    {
                        "projectId": "Project-1",
                        "environments": [
                            "Environment-1",
                            "Environment-2"
                        ]
                    }
                ]
            }
        }
    ]
}

Required fields

Field Type Description
credentials OctopusDeployCredentials The Octopus Deploy credentials
id String The Octopus Deploy collector ID
projects Array The Octopus Deploy projects to include
serverUrl String The Octopus Deploy server URL

Optional fields

Field Type Description
enabled Boolean Determines whether or not this collector is enabled

Credentials

The credentials fields is where you tell Duck how you want to authenticate with Octopus Deploy.

API Key:

"credentials": {
    "apiKey": "OCTOPUS-API-KEY"
}