oo api
Call or discover the versioned API.
Discover the routes this Sunport serves, with their inputs and permissions, and call any of them as the signed-in identity. Use it for operations that have no command of their own.
The catalog comes from the running Sunport, so it matches its version. A listed route is not a permission: the API still checks yours. A read the Sunport did not answer while it restarts is sent again for about 30 seconds. A mutation is sent once and never retried; after a timeout, read the resource back before sending it again.
oo api routes
List the routes of the running OpenOrange API with their method, path, auth and transport. Narrow the list with --method, a --path prefix or --auth; --json prints the catalog entries.
oo api routes [options]| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
--method METHOD | no | |||
--path PATH | no | |||
--auth AUTH | no | filter recorded auth metadata, not permission grants | ||
--json | no |
oo api route
Show one route with its path parameters and recorded schemas: the inputs to use with oo api request, or with oo run for POST /api/v1/jobs. That route's body covers every job; --capability shows only the requests that run as one capability.
oo api route [options] method path| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
method | yes | HTTP method, such as POST | ||
path | yes | concrete or registered route path, such as /api/v1/jobs | ||
--capability CAPABILITY | no | with POST /api/v1/jobs, a capability as oo run names it, such as agents.config | ||
--json | no |
oo api request
Call one route as the signed-in identity and print its response. Send a body with --json, --body, --form or --file; save a binary response with --output; follow a server-sent event stream with --stream. Redirects are never followed and a mutation is never retried.
oo api request [options] METHOD path| Argument | Required | Default | Choices | Description |
|---|---|---|---|---|
METHOD | yes | HTTP method, such as GET or POST | ||
path | yes | /api/v1/path or /path shorthand | ||
--query NAME=VALUE | no | |||
--header NAME=VALUE | no | non-credential protocol header; NAME=@FILE is supported | ||
--json @FILE|@- | no | |||
--body @FILE|@- | no | |||
--content-type CONTENT_TYPE | no | |||
--form NAME=VALUE | no | |||
--file NAME=@FILE | no | |||
--output OUTPUT | no | explicit file for binary responses | ||
--overwrite | no | |||
--stream | no | |||
--timeout TIMEOUT | no | 15 | ||
--max-time MAX_TIME | no | 300 | ||
--max-bytes MAX_BYTES | no | 4194304 | ||
--max-body MAX_BODY | no | 4194304 |
It also takes the connection options.