Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Browse the OneCLI app catalog, connect apps with OAuth or credentials, bring your own OAuth client, read tool catalogs, and manage app blocklists.
| Endpoint | Method and path | What it does |
|---|---|---|
| List apps | GET /apps | List every app in the OneCLI catalog with its connection method, whether your own OAuth client is set up, and your workspace’s connections. |
| List configured apps | GET /apps/configured | List the provider ids that have an enabled OAuth client configuration, set in your workspace or inherited from the organization. |
| Get the app allowlist for this workspace | GET /apps/available | Check which apps your workspace may connect under the organization’s app-availability rules. |
| List apps with platform-provided OAuth clients | GET /apps/env-defaults | List the apps whose OAuth client comes from the deployment’s environment, so they connect without setting up your own client first. |
| List every app’s tool catalog | GET /apps/permission-definitions | Get the static tool catalog for every app that has one, with tool ids, names, and descriptions grouped into read and write. |
| Get an app | GET /apps/{provider} | Get one app with its connections in your workspace and a readable hint that tells you what to do next to connect it. |
| Get an app’s tool catalog | GET /apps/{provider}/permission-definition | Get one app’s tool catalog: the tool ids that grant allow and ask lists and policy rule tools may reference. |
| Start an OAuth connect | GET /apps/{provider}/authorize | Start an OAuth connect by sending the browser to the provider’s consent screen. |
| Connect an app with credentials | POST /apps/{provider}/connect | Connect an API-key or credentials-import app from the fields you send. |
| Get an app’s OAuth client configuration | GET /apps/{provider}/config | Check whether your workspace has its own OAuth client for an app, or inherits one from the organization. |
| Set an app’s OAuth client configuration | POST /apps/{provider}/config | Store your own OAuth client credentials for an app at the workspace level. |
| Remove an app’s OAuth client configuration | DELETE /apps/{provider}/config | Remove your workspace’s own OAuth client for an app and disconnect the connections minted from it. |
| Enable or disable an app’s OAuth client configuration | PATCH /apps/{provider}/config/toggle | Enable or disable your workspace’s OAuth client configuration for an app without deleting it. |
| Get an app’s blocklist state | GET /apps/{provider}/blocklist | See an app’s predefined blockable hosts and whether each is blocked for your workspace or organization. |
| Block one of an app’s hosts | POST /apps/{provider}/blocklist | Block one of an app’s predefined hosts, or re-enable an existing block, so agents can’t reach that host through the gateway. |
| Enable or disable a blocklist entry | PATCH /apps/{provider}/blocklist/{ruleId} | Turn an existing app blocklist entry on or off without removing it, so you can pause a host block and restore it later. |
| Remove a blocklist entry | DELETE /apps/{provider}/blocklist/{ruleId} | Remove an entry from an app’s blocklist so the host is no longer blocked by that rule for agents in your workspace. |
