octopus api

Execute an authenticated GET request against the Octopus Server API and print the JSON response.

Usage:
  octopus api <url> [flags]

Global Flags:
  -h, --help                   Show help for a command
      --no-prompt              Disable prompting in interactive mode
  -f, --output-format string   Specify the output format for a command ("json", "table", or "basic") (default "table")
  -s, --space string           Specify the space for operations

Examples

Octopus Samples instance

Many of the examples we use, reference the samples instance of Octopus Deploy. If you’d like to explore the samples instance, you can log in as a guest.

octopus api /api
octopus api /api/spaces
octopus api /api/Spaces-1/projects

Learn more

Octopus CLI
Creating API keys

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, April 19, 2026

Edit on GitHub