Skip to content

jn:get

Execute a JSONAPI request.

Examples

  • drush jn:get jsonapi/node/article. Get a list of articles back as JSON.
  • drush jn:get jsonapi/node/article | jq. Pretty print JSON by piping to jq. See https://stedolan.github.io/jq/ for lots more jq features.

Arguments

  • url. The JSONAPI URL to request.

Options

  • ** --format[=FORMAT]. Format the result data. Available formats: csv,json,list,null,php,print-r,tsv,var_dump,var_export,xml,yaml [default: json]
  • ** --fields=FIELDS**. Limit output to only the listed elements. Name top-level elements by key, e.g. "--fields=name,date", or use dot notation to select a nested element, e.g. "--fields=a.b.c as example".
  • ** --field=FIELD. Select just one field, and force format to string.

Global Options

  • ** -v|vv|vvv, --verbose**. Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • ** -y, --yes**. Auto-accept the default for all user prompts. Equivalent to --no-interaction.
  • ** -l, --uri=URI. A base URL for building links and selecting a multi-site. Defaults to https://default.
  • To see all global options, run drush topic and pick the first choice.

Legend

  • An argument or option with square brackets is optional.
  • Any default value is listed at end of arg/option description.
  • An ellipsis indicates that an argument accepts multiple values separated by a space.