Connections Connected Services API

The Connected Services API from Connections — 10 operation(s) for connected services.

GitHub OpenAPI

Operations 12

GET /v1/connected-services List this company's connected services - one row per stored credential… #
PATCH /v1/connected-services/{id} Rename an instance ({instanceName}) OR archive/unarchive it ({archived… #
DELETE /v1/connected-services/{id} DESTRUCTIVE - disconnect a connected service: permanently deletes the stored… #
POST /v1/connected-services/{id}/health IS THIS CREDENTIAL ALIVE RIGHT NOW - probe ONE connection against its provider… #
POST /v1/connected-services/aws/refresh-names ⭐ MAKE STUDIO AGREE WITH AWS ABOUT WHAT AN ACCOUNT IS CALLED. #
POST /v1/connected-services/aws/root-accounts ⭐ STEP 1 OF CONNECTING AN AWS ACCOUNT YOURSELF - what accounts can this saved… #
POST /v1/connected-services/aws/connect-from-root ⭐ STEP 2 - CONNECT one of those accounts into this workspace, and then get on… #
GET /v1/connected-services/aws/borrowable-roots ⭐ WHICH OF THE MEMBER'S OTHER WORKSPACES HOLD AN AWS ROOT YOU COULD CONNECT AN… #
GET /v1/connected-services/{id}/credential-fields The NON-SECRET fields of this connection's stored credential, so an edit can… #
POST /v1/connected-services/{id}/resource Set what this connection is focused on ({kind, id?, name?, repoId?})… #
GET /v1/connected-services/{id}/discord/branding How the shared Connections Discord bot appears INSIDE this connection's own… #
PATCH /v1/connected-services/{id}/discord/branding White-label the bot inside this connection's own server: {nick, bio, avatar… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/connections-icu:connections-icu-connected-services-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

connections-icu-connected-services-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Connections Icu Connected Services API
  version: 1.0.0
  description: 'Operations tagged Connected Services across 2 of this provider''s published API definitions: connections-icu-studio-openapi-original.json, connections-icu-studio-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://studio.connectionsapi.com
tags:
- name: Connected Services
paths:
  /v1/connected-services:
    get:
      summary: List this company's connected services - one row per stored credential…
      security:
      - aegisBearer: []
      - apiKey: []
      tags:
      - Connected Services
      operationId: getV1ConnectedServices
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/connected-services/{id}:
    patch:
      summary: Rename an instance ({instanceName}) OR archive/unarchive it ({archived…
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Send {instanceName} to rename, OR {archived} to archive or unarchive; a boolean archived wins when both are sent.
              properties:
                instanceName:
                  type: string
                  description: The per-company instance name, trimmed to 60 characters. Must be unique for that service within the project. Required to rename.
                  maxLength: 60
                archived:
                  type: boolean
                  description: true archives the connection (hidden from what a company key sees); false restores it.
                  x-setting:
                    id: studio.connection_archived
                    label: Connection archived
                    synonyms:
                    - archive connection
                    - hide connection
                    - hide from ai
                    - unarchive
                    scope: connected_service
                    group: Connected services
                    scopeParam: id
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Connected Services
      operationId: patchV1ConnectedServicesById
      x-operation-id-source: derived
    delete:
      summary: 'DESTRUCTIVE - disconnect a connected service: permanently deletes the stored…'
      security:
      - aegisBearer: []
      - apiKey: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Connected Services
      operationId: deleteV1ConnectedServicesById
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/connected-services/{id}/health:
    post:
      summary: IS THIS CREDENTIAL ALIVE RIGHT NOW - probe ONE connection against its provider…
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
              description: No fields - the path and your credential are the entire input.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Connected Services
      operationId: postV1ConnectedServicesByIdHealth
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/connected-services/aws/refresh-names:
    post:
      summary: ⭐ MAKE STUDIO AGREE WITH AWS ABOUT WHAT AN ACCOUNT IS CALLED.
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - connectionId
              properties:
                connectionId:
                  type: string
                  description: 'REQUIRED. The ORG-CAPABLE AWS connection to read the truth THROUGH - a management or root key that can call organizations:ListAccounts. It is required rather than guessed on your behalf: picking a credential for you is how one org''s names get written onto another org''s rows.'
                apply:
                  type: boolean
                  description: Default FALSE, which reports the drift and writes nothing - the safe first call, and useful on its own as a list of every connection whose label we have wrong. Pass true to correct them.
      tags:
      - Connected Services
      operationId: postV1ConnectedServicesAwsRefreshNames
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/connected-services/aws/root-accounts:
    post:
      summary: ⭐ STEP 1 OF CONNECTING AN AWS ACCOUNT YOURSELF - what accounts can this saved…
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - fromRootInstance
              properties:
                fromRootInstance:
                  type: string
                  description: 'REQUIRED. The instance NAME of a saved AWS ROOT/parent connection to act with - never a key. Roots in THIS workspace come from connections_accounts { service: "aws" } (isRoot: true); roots in the member''s other workspaces come from GET /v1/connected-services/aws/borrowable-roots.'
                fromRootWorkspace:
                  type: string
                  description: Optional. The other workspace that root lives in (its project id, company id, or exact name), when you are borrowing one from GET .../borrowable-roots. Re-authorized on every call against the member's standing cross-workspace consent - passing it is a request, never a grant.
                environment:
                  type: string
                  description: Optional. Which environment to act in; defaults to the caller's own.
                  enum:
                  - prod
                  - dev
      tags:
      - Connected Services
      operationId: postV1ConnectedServicesAwsRootAccounts
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/connected-services/aws/connect-from-root:
    post:
      summary: ⭐ STEP 2 - CONNECT one of those accounts into this workspace, and then get on…
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - fromRootInstance
              - targetAccountId
              properties:
                fromRootInstance:
                  type: string
                  description: REQUIRED. Same saved-root NAME you passed to .../root-accounts. Never a key.
                fromRootWorkspace:
                  type: string
                  description: Optional. The other workspace the root lives in - same value and same re-authorization as above.
                targetAccountId:
                  type: string
                  description: 'REQUIRED, 12 digits. Which account from the .../root-accounts list to connect. Deliberately NOT defaulted: an omitted account would silently connect the root''s OWN account instead of the one you meant.'
                targetAccountName:
                  type: string
                  description: Optional. The account's name, if you already have it - otherwise it is read from AWS Organizations.
                instanceName:
                  type: string
                  description: Optional. What to call the new connection in this workspace (60 chars). Defaults to 'default'.
                  maxLength: 60
                environment:
                  type: string
                  description: Optional. Which environment the new connection belongs to.
                  enum:
                  - prod
                  - dev
      tags:
      - Connected Services
      operationId: postV1ConnectedServicesAwsConnectFromRoot
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/connected-services/aws/borrowable-roots:
    get:
      summary: ⭐ WHICH OF THE MEMBER'S OTHER WORKSPACES HOLD AN AWS ROOT YOU COULD CONNECT AN…
      security:
      - aegisBearer: []
      - apiKey: []
      tags:
      - Connected Services
      operationId: getV1ConnectedServicesAwsBorrowableRoots
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/connected-services/{id}/credential-fields:
    get:
      summary: The NON-SECRET fields of this connection's stored credential, so an edit can…
      security:
      - aegisBearer: []
      - apiKey: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Connected Services
      operationId: getV1ConnectedServicesByIdCredentialFields
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/connected-services/{id}/resource:
    post:
      summary: Set what this connection is focused on ({kind, id?, name?, repoId?})…
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - kind
              properties:
                kind:
                  type: string
                  description: 'REQUIRED. What this connection is focused on: ''all'' = the whole installation/account and clears any narrowing, or a concrete kind such as ''repo'', ''account'', ''org''.'
                  maxLength: 40
                  x-setting:
                    id: studio.connection_focus
                    label: What a connection is focused on
                    synonyms:
                    - connection focus
                    - limit to one repo
                    - whole account
                    - github repo access
                    scope: connected_service
                    group: Connected services
                    scopeParam: id
                id:
                  type: string
                  description: REQUIRED unless kind is 'all'. The provider's id for the pick (a GitHub full_name, an AWS account id).
                  maxLength: 200
                name:
                  type: string
                  description: REQUIRED unless kind is 'all'. The display name stored on the row.
                  maxLength: 200
                detail:
                  type: string
                  description: Optional second line shown beside the pick.
                  maxLength: 200
                repoId:
                  type: integer
                  description: 'GitHub only, and the field that actually MOVES THE WALL: the NUMERIC repo id for a {kind:''repo''} pick. Present = the next installation token is minted scoped to that repo alone; absent, or kind:''all'', = minted at full installation breadth.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Connected Services
      operationId: postV1ConnectedServicesByIdResource
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
  /v1/connected-services/{id}/discord/branding:
    get:
      summary: How the shared Connections Discord bot appears INSIDE this connection's own…
      security:
      - aegisBearer: []
      - apiKey: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Connected Services
      operationId: getV1ConnectedServicesByIdDiscordBranding
      x-operation-id-source: derived
    patch:
      summary: 'White-label the bot inside this connection''s own server: {nick, bio, avatar…'
      security:
      - aegisBearer: []
      - apiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                nick:
                  type: string
                  description: The bot's display name INSIDE this server. null clears the override and falls back to its global name.
                  maxLength: 32
                  nullable: true
                  x-setting:
                    id: studio.discord_bot_name
                    label: Discord bot name in this server
                    synonyms:
                    - bot nickname
                    - discord bot name
                    - rename bot
                    scope: connected_service
                    group: 'Connected services: Discord branding'
                    scopeParam: id
                bio:
                  type: string
                  description: The bot's description inside this server. null clears it.
                  maxLength: 190
                  nullable: true
                  x-setting:
                    id: studio.discord_bot_bio
                    label: Discord bot description in this server
                    synonyms:
                    - bot bio
                    - discord bot about
                    - bot description
                    scope: connected_service
                    group: 'Connected services: Discord branding'
                    scopeParam: id
                avatar:
                  type: string
                  description: The bot's picture inside this server, as a data:image/... base64 data URI (under 2MB). null removes it.
                  nullable: true
                  x-setting:
                    id: studio.discord_bot_avatar
                    label: Discord bot picture in this server
                    synonyms:
                    - bot avatar
                    - bot icon
                    - discord bot photo
                    scope: connected_service
                    group: 'Connected services: Discord branding'
                    scopeParam: id
                banner:
                  type: string
                  description: The bot's background picture inside this server, same data-URI format. null removes it.
                  nullable: true
                  x-setting:
                    id: studio.discord_bot_banner
                    label: Discord bot banner in this server
                    synonyms:
                    - bot banner
                    - bot background
                    - discord bot cover
                    scope: connected_service
                    group: 'Connected services: Discord branding'
                    scopeParam: id
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Connected Services
      operationId: patchV1ConnectedServicesByIdDiscordBranding
      x-operation-id-source: derived
    servers:
    - url: https://studio.connectionsapi.com
components:
  securitySchemes:
    aegisBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: The AEGIS SSO access token (Cognito JWT from the shared sign-in) presented as a Bearer on every /v1 call.
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: cnx_live_* | cnx_pub_*
      description: 'A key minted in the console, sent as a bearer token. `cnx_live_` carries cross-plane data scopes AND (when granted) Studio management scopes (apps:*, keys:*, projects:*, webhooks:*) that authorize the console-management operations below. `cnx_pub_` is the publishable, browser-safe tier (Stripe''s pk_ model): mint-time capped to :read scopes, requires a non-empty allowed-origins allowlist, refused on any non-GET/HEAD route, and rate-limited - safe to embed in client-side code.'
    oauthUserToken:
      type: http
      scheme: bearer
      description: EITHER (a) a Sign-in-with-Connections USER access token issued by accounts.connectionsapi.com to a registered OAuth app - the app acts on behalf of its signed-in user, rows are keyed by the token's own sub + client_id; OR (b) an app-bound publishable key (cnx_pub_, minted with an appId) presented on X-Connections-Api-Key ALONGSIDE the signed-in user's own plain AEGIS bearer on Authorization - the server derives (app_id, sub) from the two verified credentials. The publishable key alone authorizes nothing; both credentials are required. This second form is for a developer who wants the locker without standing up a full OAuth client - mint one publishable key bound to a registered app instead.
x-refined-from:
- connections-icu-studio-openapi-original.json
- connections-icu-studio-openapi.yml