maton api

maton api <endpoint> [flags]

Makes an authenticated HTTP request to the Maton API and prints the response.

The endpoint argument should be a path of a Maton API endpoint.

The default HTTP request method is GET normally and POST if any parameters were added. Override the method with --method.

Pass one or more -f/--raw-field values in key=value format to add static string parameters to the request payload. To add non-string values, see -F/--field below. Note that adding request parameters will automatically switch the request method to POST. To send the parameters as a GET query string instead, use --method GET.

The -F/--field flag has magic type conversion based on the format of the value:

• literal values true, false, null, and integer numbers get converted to appropriate JSON types;
• if the value starts with @, the rest of the value is interpreted as a filename to read the value from. Pass - to read from standard input.

To pass nested parameters in the request payload, use key[subkey]=value syntax when declaring fields. To pass nested values as arrays, declare multiple fields with the syntax key[]=value1, key[]=value2. To pass an empty array, use key[] without a value.

To pass pre-constructed JSON or payloads in other formats, a request body may be read from file specified by --input. Use - to read from standard input. When passing the request body this way, any parameters specified via field flags are added to the query string of the endpoint URL.

In --paginate mode, all pages of results will sequentially be requested until there are no more pages of results. Each page is a separate JSON array or object. Pass --slurp to wrap all pages of JSON arrays or objects into an outer JSON array.

Options

--connection <string>

Connection ID to route through (sets Maton-Connection header)

-F, --field <key=value>

Add a typed parameter in key=value format (use "@<path>" or "@-" to read value from file or stdin)

-H, --header <key:value>

Add a HTTP request header in key:value format

--hostname <string>

The Maton hostname for the request (default "api.maton.ai")

-i, --include

Include HTTP response status line and headers in the output

--input <file>

The file to use as body for the HTTP request (use "-" to read from standard input)

-q, --jq <string>

Query to select values from the response using jq syntax

-X, --method <string> (default "GET")

The HTTP method for the request

--paginate

Make additional HTTP requests to fetch all pages of results

-f, --raw-field <key=value>

Add a string parameter in key=value format

--silent

Do not print the response body

--slurp

Use with "--paginate" to return an array of all pages of either JSON arrays or objects

-t, --template <string>

Format JSON output using a Go template; see "maton help formatting"

--verbose

Include full HTTP request and response in the output

Options inherited from parent commands

-p, --profile <string>

Profile to use for this invocation (overrides the active profile; also reads MATON_PROFILE)

Examples

# List your connections
$ maton api /connections

# Filter connections by app
$ maton api -X GET connections -f app=slack

# Use a JSON file as request body
$ maton api /connections --input file.json

# Set a custom HTTP header
$ maton api -H 'Accept: application/json' connections

# Print only specific fields from the response
$ maton api /connections --jq '.[].id'

# Use a template for the output
$ maton api /connections --template \
  '{{range .}}{{.id}} ({{.app | color "yellow"}}){{"\n"}}{{end}}'

See also

• maton