Skip to main content
PUT
Create or Replace Connection

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Path Parameters

name
string
required

Body

application/json
base_url
string
required

HTTPS URL of the API. Agents can only call this URL and paths under it.

Maximum string length: 2048
secret
any

API key, token or password for the API. Required to create a connection. Omit on a replace to keep the saved secret. Use a read-only credential where you can.

description
string | null

One line telling agents what the connection is for.

Maximum string length: 2000
sign_in
SignIn · object | null

How the secret is sent. Default: a bearer token in the Authorization header.

username
any

Username for a basic sign-in. The secret is sent as its password.

allowed_requests
string[] | null

Requests agents may make, each a method and a path under base_url, such as POST /search. Omit to allow GET and HEAD on any path.

Maximum array length: 100
Maximum string length: 2048
create_only
boolean
default:false

If true, fails when a connection with this name already exists instead of replacing it. Default: false.

Response

Successful Response

name
string
required

Connection name. Agents and runs refer to the connection by this name.

description
string
required

What the connection is for. Empty when none was given.

base_url
string
required

HTTPS URL of the API.

sign_in
SignIn · object
required

How the secret is sent.

allowed_requests
string[] | null
required

Requests agents may make. Null means GET and HEAD on any path under base_url.

Maximum string length: 2048
secret_last4
string
required

Last four characters of the secret. The secret itself is never returned.

created
boolean
required

If true, this request created the connection. If false, it replaced one.

created_at
string<date-time> | null

Creation time in UTC.

updated_at
string<date-time> | null

Last update time in UTC.