Skip to main content
PUT
Create or replace a connected source

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Path Parameters

name
string
required

Body

application/json
base_url
string | null

Required. An https URL, such as https://api.example.com/v2

Maximum string length: 2048
secret
any

The API key, token or password, best a read-only one. Required to create; leave it out to keep the saved one

description
string | null

One line: what it's for

Maximum string length: 2000
sign_in
SignIn · object | null

How the secret is sent; bearer when left out

username
any

For a basic sign-in, sent with the secret as its password

allowed_requests
string[] | null

A method and a path under the base URL each, such as 'POST /search'; left out, calls may GET and HEAD anywhere under it

Maximum string length: 2048
team_id
string | null

The team the change was made for; refused when the caller's active team is another

Maximum string length: 200
create_only
boolean
default:false

Only create: refused when the team already has a connection by this name

Response

Successful Response

id
string
required
name
string
required

How a run and its agents name the connection

description
string
required

What it's for, as the agents read it; empty for none

base_url
string
required

Where the API lives: calls go to this https URL and paths under it

sign_in
SignIn · object
required
allowed_requests
string[] | null
required

The requests a call may make, a method and a path under the base URL each; null for read-only (GET and HEAD anywhere under it)

secret_last4
string
required

The last four characters of the secret; the secret itself is never returned

created
boolean
required

True when this write created the connection, false when it replaced one

created_at
string<date-time> | null
updated_at
string<date-time> | null