Verentis

Raw API

The raw API escape hatch

Call any platform endpoint directly, with authentication and scoping handled for you.

Anything without a dedicated command is one escape hatch away. verentis api calls any platform endpoint through the gateway, minting a correctly scoped access token for you.

verentis api GET /v1/roles --scope security.role.read-all

verentis api POST /v1/things \
  --body @thing.json \
  --workspace <id> \
  --scope some.scope

Options

<method> <path>
Required

HTTP method and path, e.g. GET /v1/workspaces.

--scope <scope...>

Scopes to request on the access token. Repeatable.

--workspace <id>

Bind the access token to a workspace.

--body <json>

JSON request body. Use @file.json to read from a file, or - for stdin.

--query <key=value...>

Query string parameters. Repeatable.

--content-type <type>

Content type for --body when it isn't JSON.

--raw

Print the raw response body without JSON pretty-printing.

Auth is handled

You still declare the --scopes the call needs, but the CLI acquires and attaches the access token — you never handle tokens by hand.