GLOBUS API FLOWS

NAME

globus api flows - Make API calls to Globus Flows

SYNOPSIS

globus api flows [OPTIONS] {HEAD|GET|PUT|POST|PATCH|DELETE} PATH

DESCRIPTION

Make API calls to Globus Flows

The arguments are an HTTP method name and a path within the service to which the request should be made. The path will be joined with the known service URL. For example, a call of

globus api flows GET /foo/bar

sends a 'GET' request to 'https://flows.automate.globus.org/foo/bar'

OPTIONS

--scope-string TEXT

A scope string that will be used when making the api call. At present, only supported for confidential-client based authorization. Pass this option multiple times to specify multiple scopes.

--no-retry

Disable built-in request retries

-L, --allow-redirects, --location

If the server responds with a redirect (a 3xx response with a Location header), follow the redirect. By default, redirects are not followed.

--allow-errors

Allow error responses (4xx and 5xx) to be displayed without triggering normal error handling

--body-file FILENAME

A request body to include, as a file. Mutually exclusive with --body

--body TEXT

A request body to include, as text

-H, --header Key:Value

A header, specified as 'Key: Value'. Use this option multiple times to pass multiple headers.

--content-type [json|form|text|none|auto]

Use a specific Content-Type header for the request. The default (auto) detects a content type from the data being included in the request body, while the other names refer to common data encodings. Any explicit Content-Type header set via '--header' will override this

-Q, --query-param Key=Value

A query parameter, given as 'key=value'. Use this option multiple times to pass multiple query parameters.

-v, --verbose

Control level of output, make it more verbose.

--quiet

Suppress non-essential output. This is higher precedence than --verbose.

-h, --help

Show this message and exit.

-F, --format [unix|json|text]

Output format for stdout. Defaults to text.

--jmespath, --jq TEXT

A JMESPath expression to apply to json output. Forces the format to be json processed by this expression.

--map-http-status TEXT

Map HTTP statuses to any of these exit codes: 0,1,50-99. e.g. "404=50,403=51"

EXIT STATUS

0 on success.

1 if a network or server error occurred, unless --map-http-status has been used to change exit behavior on http error codes.

2 if the command was used improperly.

3 if the command was used on the wrong type of object, e.g. a collection command used on an endpoint.

4 if the command has authentication or authorization requirements which were not met, as in ConsentRequired errors or missing logins.