Skip to content
UltimateTeam.ai Docs

Create a forged connector

POST
/api/v1/forge/connectors

Persist a new forged connector for the calling tenant.

RPE-01 (v46.0): chairman-only. Operators may edit existing connectors via PUT, but only the chairman can spin up new ones because each new connector is a new outbound trust boundary.

Authorizations

Request Body required

POST body.

object
template
required

Tenant-supplied connector template payload.

object
auth_type
required
string
/^(oauth2|api_key|basic)$/
base_url
required
string
>= 1 characters <= 500 characters
description
string
"" <= 500 characters
endpoints
Array<object>
<= 50 items

Inbound endpoint spec on create / update.

object
body_schema
object
key
additional properties
any
method
required
string
<= 8 characters
path
required
string
>= 1 characters <= 500 characters
query_params
object
key
additional properties
any
response_schema
object
key
additional properties
any
name
required
string
>= 1 characters <= 120 characters
oauth_config
Any of:
object
key
additional properties
any
rate_limits

Inbound rate-limit spec.

object
per_day
integer
per_hour
integer
per_minute
integer

Responses

201

Successful Response

Wire shape for read / list endpoints.

object
created_at
required
string format: date-time
id
required
string format: uuid
last_sync_at
Any of:
string format: date-time
status
required
string
template
required
object
key
additional properties
any
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string