Documentation menu

CLI

Use Octopus docs with AI

octopus api

Execute a raw API GET request

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