connections.getConnection

GET

/v1/connections/{connectionId}

curl --request GET \
  --url https://example.com/v1/connections/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• token
• session

Parameters

Path Parameters

connectionId

required

string

>= 1 characters

Responses

200

Success

Media typeapplication/json

object

id

required

string

>= 1 characters

name

required

string

<= 80 characters

cardUrl

required

Any of:

string

string

string

string

card

required

object

$schema

required

string

Allowed values: https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json

name

required

string

>= 2 characters <= 200 characters

version

required

string

>= 1 characters <= 255 characters

description

required

string

>= 1 characters <= 100 characters

title

Any of:

string

string

>= 1 characters <= 100 characters

null

null

websiteUrl

Any of:

string

string

null

null

repository

Any of:

object

object

url

required

string

source

required

string

subfolder

Any of:

string

string

null

null

id

Any of:

string

string

null

null

null

null

icons

Any of:

Array<object>

Array<object>

object

src

required

string

mimeType

Any of:

string

string

null

null

sizes

Any of:

Array<string>

Array<string>

null

null

theme

Any of:

string

string

Allowed values: light dark

null

null

null

null

remotes

Any of:

Array<object>

Array<object>

object

type

required

string

Allowed values: streamable-http sse

url

required

string

headers

Any of:

Array<object>

Array<object>

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

name

required

string

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

null

null

variables

Any of:

object

object

key

additional properties

object

description

Any of:

string

string

null

null

isRequired

Any of:

boolean

boolean

null

null

isSecret

Any of:

boolean

boolean

null

null

format

Any of:

string

string

Allowed values: string number boolean filepath

null

null

default

Any of:

string

string

null

null

placeholder

Any of:

string

string

null

null

value

Any of:

string

string

null

null

choices

Any of:

Array<string>

Array<string>

null

null

null

null

supportedProtocolVersions

Any of:

Array<string>

Array<string>

null

null

null

null

_meta

Any of:

object

object

null

null

endpoint

required

string

remoteIndex

required

integer

<= 9007199254740991

sources

required

Array<object>

object

role

required

string

Allowed values: input page catalog card endpoint manual

url

required

string

originalInput

Any of:

string

string

null

null

configuration

required

object

key

additional properties

string

enabled

required

boolean

revision

required

integer

<= 9007199254740991

availability

required

Any of:

object

object

_tag

required

string

Allowed values: PendingConfiguration

object

object

_tag

required

string

Allowed values: PendingAuthorization

scopes

required

Array<string>

object

object

_tag

required

string

Allowed values: Unverified

object

object

_tag

required

string

Allowed values: Available

checkedAt

required

number

revision

required

integer

<= 9007199254740991

object

object

_tag

required

string

Allowed values: AuthorizationExpired

object

object

_tag

required

string

Allowed values: ConnectionFailed

message

required

string

object

object

_tag

required

string

Allowed values: NeedsRevalidation

object

object

_tag

required

string

Allowed values: CleanupPending

stage

required

string

Allowed values: Credentials Connection

object

object

_tag

required

string

Allowed values: Restricted

restriction

required

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

Example

{
  "card": {
    "$schema": "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json",
    "icons": [
      {
        "theme": "light"
      }
    ],
    "remotes": [
      {
        "type": "streamable-http",
        "headers": [
          {
            "format": "string",
            "variables": {
              "additionalProperty": {
                "format": "string"
              }
            }
          }
        ],
        "variables": {
          "additionalProperty": {
            "format": "string"
          }
        }
      }
    ]
  },
  "sources": [
    {
      "role": "input"
    }
  ],
  "availability": {
    "_tag": "PendingConfiguration"
  }
}

400

ExperienceInputInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceInputInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ExperienceInputInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

AppRestricted | PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AppRestricted

restriction

required

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

object

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read

resource

required

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "AppRestricted"
}

404

ExperienceNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: ExperienceNotFound

id

required

string

Example

{
  "_tag": "ExperienceNotFound"
}

409

ConnectionCleanupPending | ConnectionConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ConnectionCleanupPending

connectionId

required

string

stage

required

string

Allowed values: Credentials Connection

message

required

string

object

object

_tag

required

string

Allowed values: ConnectionConflict

reason

required

string

Allowed values: CandidateChanged RevisionChanged DraftExpired AlreadyAdded LimitReached

message

required

string

Example

{
  "_tag": "ConnectionCleanupPending",
  "stage": "Credentials"
}

422

AppDiscoveryFailed | ConnectionConfigurationInvalid

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AppDiscoveryFailed

reason

required

string

Allowed values: InvalidInput IncompatibleCard NoDeclaration NoUsableServices Document Http BlockedTarget Transport TooLarge Timeout Redirect Encoding

issues

required

Array<object>

object

url

required

string

reason

required

string

fieldPath

string

object

object

_tag

required

string

Allowed values: ConnectionConfigurationInvalid

message

required

string

keys

required

Array<string>

Example

{
  "_tag": "AppDiscoveryFailed",
  "reason": "InvalidInput"
}

503

ExperienceStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceStorageUnavailable

object

object

_tag

required

string

Allowed values: AuthorizationUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "ExperienceStorageUnavailable"
}