Skip to content
docstack-ocr

Create Connection Endpoint

POST
/v1/admin/connections
 
curl --request POST \
  --url http://localhost:8080/v1/admin/connections \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "protocol": "s3", "direction": "source", "config": {}, "credentials": {} }'

Request Body required

Section titled “Request Body required ”
Media type application/json
CreatePayload
object
name
required
Name
string
>= 1 characters <= 128 characters /^[A-Za-z0-9 _\-.]+$/
protocol
required
Protocol
string
Allowed values: s3 ftp sftp
direction
required
Direction
string
Allowed values: source destination both
config
required
Config
object
key
additional properties
any
credentials
required
Credentials
object
key
additional properties
any

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Media type application/json
Response Create Connection Endpoint V1 Admin Connections Post
object
key
additional properties
any
Example generated
{}

422

Section titled “422 ”

Validation Error

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