Set a waiting connection's key through its one-time key link (checked, then stored encrypted)

POST

/api/workspaces/{workspaceId}/connectors/key-requests/submit

curl --request POST \
  --url http://localhost:8080/api/workspaces/example/connectors/key-requests/submit \
  --header 'Content-Type: application/json' \
  --cookie auth_session=<auth_session> \
  --data '{ "token": "example", "config": { "additionalProperty": "example" }, "confirmedDestination": true }'

• Configured API base URL

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Request Body

Media typeapplication/json

object

token

required

The token from the key link’s fragment.

string

>= 1 characters <= 200 characters

config

required

Values for the fields the link asks for, keyed by field name.

object

key

additional properties

string

confirmedDestination

required

The person confirmed the address and settings the page showed.

boolean

Example ^generated

{
  "token": "example",
  "config": {
    "additionalProperty": "example"
  },
  "confirmedDestination": true
}

Responses

2XX

Successful response

Media typeapplication/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}