Skip to content
UltimateTeam.ai Docs

Create a forged connector

POST
/api/v1/forge/connectors
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/forge/connectors \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "credentials": { "header_name": "X-API-Key", "key_value": "example", "password": "example", "username": "example" }, "template": { "auth_type": "example", "base_url": "example", "description": "", "endpoints": [ { "body_schema": {}, "method": "example", "path": "example", "query_params": {}, "response_schema": {} } ], "name": "example", "oauth_config": {}, "rate_limits": { "per_day": 0, "per_hour": 0, "per_minute": 0 } } }'

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

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ConnectorCreateRequest

POST body.

object
credentials
Any of:
ConnectorCredentialsIn

Sealed credential bundle for api_key / basic connectors.

Never persisted on the template, version snapshots, or any response.

object
header_name
Header Name
string
default: X-API-Key <= 128 characters /^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$/
key_value
Any of:
string format: password
>= 1 characters <= 4096 characters
password
Any of:
string format: password
>= 1 characters <= 4096 characters
username
Any of:
string format: password
>= 1 characters <= 1024 characters
template
required
ConnectorTemplateIn

Tenant-supplied connector template payload.

object
auth_type
required
Auth Type
string
/^(oauth2|api_key|basic)$/
base_url
required
Base Url
string
>= 1 characters <= 500 characters
description
Description
string
"" <= 500 characters
endpoints
Endpoints
Array<object>
<= 50 items
EndpointIn

Inbound endpoint spec on create / update.

object
body_schema
Body Schema
object
key
additional properties
any
method
required
Method
string
<= 8 characters
path
required
Path
string
>= 1 characters <= 500 characters
query_params
Query Params
object
key
additional properties
any
response_schema
Response Schema
object
key
additional properties
any
name
required
Name
string
>= 1 characters <= 120 characters
oauth_config
Any of:
object
key
additional properties
any
rate_limits
RateLimitIn

Inbound rate-limit spec.

object
per_day
Per Day
integer
0
per_hour
Per Hour
integer
0
per_minute
Per Minute
integer
0

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
ConnectorResponse

Wire shape for read / list endpoints.

object
created_at
required
Created At
string format: date-time
credentials_configured
Credentials Configured
boolean
id
required
Id
string format: uuid
last_sync_at
Any of:
string format: date-time
status
required
Status
string
template
required
Template
object
key
additional properties
any
tenant_id
required
Tenant Id
string format: uuid
updated_at
required
Updated At
string format: date-time
version
required
Version
integer
Example
{
  "credentials_configured": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}