> ## Documentation Index
> Fetch the complete documentation index at: https://onecli.sh/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Which agents can reach a connection

> Which agents can use this connection, and what each can do with it. Replaces the retired `GET /connections/{connectionId}/agents`. `catalog: false` means the provider ships no tool catalog, so `decisions` is omitted rather than guessed.




## OpenAPI

````yaml /openapi.yaml get /connections/{connectionId}/effective-agents
openapi: 3.1.0
info:
  title: OneCLI API
  version: '1.0'
  description: >
    The OneCLI API lets you manage agents, secrets, policy rules, app
    connections, and user settings programmatically.


    **Base URL:** `https://api.onecli.sh/v1` (Cloud) or
    `http://localhost:10254/v1` (self-hosted)


    ## Authentication


    All endpoints require authentication via one of:


    - **API Key** — `Authorization: Bearer <key>` header. Generate keys in the
    dashboard or via `GET /v1/user/api-key`.

    - **Session** — Cookie-based session from the web dashboard.


    For organization-scoped API keys, include the `X-Project-Id` header to
    specify which project to operate on.
servers:
  - url: https://api.onecli.sh/v1
    description: OneCLI Cloud
  - url: http://localhost:10254/v1
    description: Self-hosted (Docker)
security:
  - bearerAuth: []
tags:
  - name: Agents
    description: Manage agents and their access tokens, secrets, and configuration.
  - name: Secrets
    description: Manage credentials that the gateway injects into outbound requests.
  - name: Policy
    description: >-
      Author project policy-engine rules that control how agents interact with
      external services (staged draft → publish).
  - name: Approvals
    description: >-
      Long-poll for pending manual-approval requests and submit approve/deny
      decisions.
  - name: User
    description: Manage your user profile and API keys.
  - name: Projects
    description: >-
      Manage projects within your organization. Requires admin role for
      create/update and owner role for delete. Cloud only.
  - name: Team
    description: Provision team members programmatically. Requires admin role. Cloud only.
  - name: Apps
    description: >-
      Manage app connections (OAuth and direct credentials), BYOC configuration,
      permission catalogs, and blocklists.
  - name: Connections
    description: App connections as a top-level resource.
  - name: Utility
    description: Health check and project resource summaries.
  - name: Agent Setup
    description: >-
      Endpoints agents and orchestrators use to bootstrap gateway access
      (container config, credential stubs, gateway skill).
  - name: Migration
    description: Migrate data from a self-hosted instance to OneCLI Cloud.
  - name: Organization Settings
    description: >-
      Organization-wide policy settings. Available on OneCLI Cloud and
      self-hosted Enterprise.
  - name: Organization Secrets
    description: >-
      Manage secrets at the organization level. Organization secrets apply
      across all projects. Available on OneCLI Cloud and self-hosted Enterprise.
  - name: Organization Policy
    description: >-
      Author policy-engine rules at the organization level. Organization rules
      apply across all projects. Available on OneCLI Cloud and self-hosted
      Enterprise.
  - name: Organization Connections
    description: >-
      Manage app connections at the organization level. Available on OneCLI
      Cloud and self-hosted Enterprise.
  - name: Organization App Config
    description: >-
      Connect apps (OAuth and direct credentials) and manage BYOC app
      configuration at the organization level. Available on OneCLI Cloud and
      self-hosted Enterprise.
  - name: Organization Approvals
    description: >-
      Long-poll for manual-approval requests across every project in the
      organization. Available on OneCLI Cloud and self-hosted Enterprise.
  - name: Partner Organizations
    description: >-
      Create and manage customer organizations as a partner. Requires a Partner
      API key. Cloud only.
  - name: Partner Projects
    description: Manage projects within an unclaimed partner organization. Cloud only.
  - name: Partner Secrets
    description: >-
      Manage partner-level secrets inherited by every organization you manage.
      Cloud only.
  - name: Partner Budgets
    description: >-
      Cap how much an organization can spend on a partner LLM key. Owner or
      admin only. Cloud only.
  - name: Partner Members
    description: >-
      Manage who can sign in to your partner portal. Owner or admin only. Cloud
      only.
  - name: Organization Partner
    description: Inspect and detach an organization's partner relationship. Cloud only.
paths:
  /connections/{connectionId}/effective-agents:
    get:
      tags:
        - Connections
      summary: Which agents can reach a connection
      description: >
        Which agents can use this connection, and what each can do with it.
        Replaces the retired `GET /connections/{connectionId}/agents`. `catalog:
        false` means the provider ships no tool catalog, so `decisions` is
        omitted rather than guessed.
      operationId: getConnectionEffectiveAgents
      parameters:
        - name: connectionId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Every project agent, with its effective access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionEffectiveAgents'
components:
  schemas:
    ConnectionEffectiveAgents:
      type: object
      properties:
        connectionId:
          type: string
        provider:
          type: string
        catalog:
          type: boolean
          description: >-
            False = no tool catalog, so `decisions` is omitted rather than
            guessed.
        agents:
          type: array
          items:
            type: object
            properties:
              agentId:
                type: string
              name:
                type: string
              access:
                type: string
                enum:
                  - usable
                  - limited
                  - blocked
                  - none
                  - unknown
              credential:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - full
                      - viaRule
                      - none
                  provenance:
                    type: array
                    items:
                      $ref: '#/components/schemas/EffectiveProvenance'
              decisions:
                type: object
                nullable: true
                properties:
                  allowedTools:
                    type: integer
                  totalTools:
                    type: integer
                  anyApproval:
                    type: boolean
                  anyRateLimit:
                    type: boolean
    EffectiveProvenance:
      type: object
      description: >-
        Which rule decided a verdict. An organization rule's name is visible
        only to organization admins; other viewers get `redacted` set instead,
        with the name withheld.
      properties:
        scope:
          type: string
          enum:
            - organization
            - project
        redacted:
          type: boolean
        rule:
          type: object
          properties:
            logicalId:
              type: string
            name:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key obtained from the dashboard or `GET /user/api-key`

````