Octopus Report
Octopus Report runs audit reports against an Octopus Deploy server.
Requirements
Octopus Deploy 3.x
The Octopus REST API has breaking changes starting with 4.x, so this program only works with 3.x.
Go 1.17.3
Download Go
How to Build
go build -o octoreport.exe main.go
octoreport.exe
How to Use
You need to specify the Octopus server to query, either in a config.yml file, in environment variables, or in command line parameters.
config.yml
octopus:
address: https://samples.octopus.app
apikey: API-GUEST
octoreport
environment variables
export OCTOPUS_ADDRESS=https://samples.octopus.app
export OCTOPUS_APIKEY=API-GUEST
octoreport
command line parameters
octoreport octopus.address=https://samples.octopus.app octopus.apikey=API-GUEST
Setting Log Level
export LOG_LEVEL=Debug
Command Line Options
octoreport -help
Option |
Description |
-help |
display usage of this program |
-info |
display information about this program |
-config |
display program configuration that was loaded |
-server |
display the Octopus server version information |
-appsec |
display a CSV format report of users, teams, environments, roles |
-report |
display a report of all teams and their users/roles/environments/project groups/projects |
-teams |
display all teams |
-users |
display all users |
-roles |
display all user roles |
-environments |
display all environments |
-projects |
display all projects |
-projectgroups |
display all project groups |
-tenants |
display all tenants |
-channels |
display all channels |
-feeds |
display all feeds |
-lifecycles |
display all lifecycles |
-machines |
display all machines |
-machineroles |
display all machineroles |
API Documentation
Swagger UI
Octopus REST API
Octopus Deploy API
Public Sample Octopus Deploy Server
Demo Octopus Deploy
The following credentials are needed
Name |
Value |
username |
guest |
password |
guest |
API key |
API-GUEST |
Example API Calls
Hit these URLs in your browser to test access to the Octopus Deploy server.
Get Server Information
Get Teams
Get Users
Get UserRoles
Get Environments
Get Projects
Get Project Groups
Get Tenants
Get Channels
Get Feeds
Get Lifecycles
Get Machines
Get MachineRoles