Synopsis

homeboy api <project_id> <COMMAND>

Description

Make HTTP requests to a project’s configured API.

This command uses the project’s API configuration (projects/<project_id>.json) and any stored authentication (see homeboy auth).

Subcommands

get

homeboy api <project_id> get <endpoint>

post

homeboy api <project_id> post <endpoint> --apply [--body <json>] [--form <key=value>]...

Mutating requests require --apply.

put

homeboy api <project_id> put <endpoint> --apply [--body <json>] [--form <key=value>]...

Mutating requests require --apply.

patch

homeboy api <project_id> patch <endpoint> --apply [--body <json>] [--form <key=value>]...

Mutating requests require --apply.

delete

homeboy api <project_id> delete <endpoint> --apply

Mutating requests require --apply.

Notes

• <endpoint> is passed through as provided (example: /wp/v2/posts).
• --body is parsed as JSON. If parsing fails, the request is sent with body: null.
• --form key=value may be repeated for post, put, and patch; form fields take precedence over --body.
• If --body and --form are omitted, body is null.
• get is allowed without --apply; post, put, patch, and delete require --apply before Homeboy sends the request.

Output

JSON output is wrapped in the global envelope. data is the homeboy::api::ApiOutput struct.

Related

• auth
• project
• JSON output contract