Create Connection

curl --request POST \
  --url https://{api_endpoint}/v1/connections/applications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appid": "my-app-id",
  "connection_type": "basic_auth",
  "credentials": {
    "username": "my-username",
    "password": "my-password"
  },
  "shared": true
}
'

{
  "status": "success",
  "message": "Connection created successfully.",
  "connection_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

curl --request POST \
  --url https://{api_endpoint}/v1/connections/applications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appid": "my-app-id",
  "connection_type": "basic_auth",
  "credentials": {
    "username": "my-username",
    "password": "my-password"
  },
  "shared": true
}
'

{
  "status": "success",
  "message": "Connection created successfully.",
  "connection_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

appid

string

required

Application ID for the connection.

connection_type

enum<string>

required

Type of connection. Must match one of the supported authentication methods.

Available options:

basic_auth,

bearer_token,

api_key_auth,

oauth2_auth_code,

oauth2_implicit,

oauth2_password,

oauth2_client_creds,

key_value_creds

credentials

object

required

Authentication credentials for the connection.

Show child attributes

shared

boolean

default:true

required

Whether the connection is shared. Defaults to true.

Response

Connection created successfully.

status

string

Example:

"success"

message

string

Example:

"Connection created successfully."

connection_id

string

Example:

"123e4567-e89b-12d3-a456-426614174000"

Get Connections

Delete Connection

Release Notes

Get Started

Build

Analyze

watsonx Orchestrate Developer Edition

watsonx Orchestrate ADK MCP Server

Reference

Legal notices

Authorizations

Body

Response