Skip to main content

hivepaas api

Call any endpoint of the API, as the spec documents it: PATH is under /api.

{project}, {env} and {app} in PATH are filled in from the flags or the directory's link. -d sends a JSON body: the text itself, @FILE, or @- for stdin. The response's body goes to stdout as it came, JSON indented, or YAML with -o yaml.

hivepaas api METHOD PATH [flags]

Examples:

hivepaas api GET /projects/{project}/{env}/apps/{app}/routing-settings
hivepaas api PUT /projects/{project}/{env}/apps/{app}/health-check-settings -d @health.json

Flags:

FlagDescription
-d, --data stringthe request's JSON body: the text, @FILE, or @- for stdin

The global flags apply to every command.