Skip to main content

revos api

Call any RevOS REST endpoint directly, reusing your stored auth, API base URL, and organization context. Useful for scripts, debugging, and endpoints not yet covered by typed resource commands.

Usage

revos api <path> [-X <method>] [-H 'Name: value']... [-q 'key=value']... [--body JSON|@file|-] [--json]
FlagMeaning
-X, --methodHTTP method (default GET; case-insensitive).
-H, --headerExtra request header ('Name: value'). Repeatable.
-q, --queryQuery parameter ('key=value'). Repeatable; repeated keys become arrays.
--bodyRequest body — inline JSON, @file, or - (stdin).
--jsonNo-op for content (output is already JSON); changes error formatting.

Output is the pretty-printed response body, including the { data, metadata } envelope that list endpoints use — so metadata.nextPageToken stays visible for scripted pagination.

Examples

revos api /organizations
revos api /tables -q pageSize=50 -q 'orderBy=createdAt desc'
revos api /connections -X POST --body '{"name":"my-conn"}'
revos api /connections -X POST --body @body.json
revos api /segments/seg_123 -X DELETE
revos api /organizations -H 'X-Foo: bar'

Errors

Errors follow the same conventions as other commands: 401 prompts you to run revos auth login, 404 reports the missing URL, 5xx surfaces the server error.