Import a connection by submitting credentials directly (programmatic)
Porte B (programmatic/headless): the backend already holds the credential and submits it directly to create the connection — the server-to-server analogue of the hosted Connect portal. Use for api_key / basic / custom auths. For OAuth2 auths use the headless OAuth start (initiateIntegrationOAuth); for interactive/human flows where the secret should never transit the caller, use the hosted Connect portal (initiateIntegrationConnect).
A credential the platform mints (the private_key of @appstrate/ssh) is refused with a 400 naming the field; such an auth connects through the Connect portal (initiateIntegrationConnect).
/api/integrations/{packageId}/auths/{authKey}/connect/fieldsCookie session from Better Auth. Requires X-Org-Id header for org-scoped routes.
In: cookie
Path Parameters
Integration package id (e.g. @official/gmail).
^@[a-z0-9][a-z0-9-]*/[a-z0-9][a-z0-9-]*$Auth key as declared in the manifest's auths map.
^[a-z][a-z0-9_]*$Header Parameters
Organization ID. Required for cookie auth. Not needed for API key auth (org resolved from key).
uuidSpace ID. Required for space-scoped routes (agents, runs, schedules, and space-scoped module routes). Not needed for API key auth (space resolved from key).
Request Body
application/json
curl -X POST "https://your-instance/api/integrations/string/auths/string/connect/fields" \ -H "Content-Type: application/json" \ -d '{ "credentials": {} }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"integration_package_id": "string",
"auth_key": "string",
"account_id": "string",
"identity_claims": {},
"scopes_granted": [
"string"
],
"needs_reconnection": true,
"expiresAt": "2019-08-24T14:15:22Z",
"owner_type": "user",
"owner_id": "string",
"owner_name": "string",
"locked_by": "admin_pin",
"label": "string",
"shared_with_org": true,
"client_ref": "string",
"variables": {
"property1": "string",
"property2": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"type": "https://docs.appstrate.dev/errors/validation-failed",
"title": "Validation Failed",
"status": 400,
"detail": "name: Invalid input: expected string, received undefined (+2 more)",
"code": "validation_failed",
"request_id": "req_abc123",
"errors": [
{
"field": "name",
"code": "required",
"message": "Invalid input: expected string, received undefined"
},
{
"field": "email",
"code": "invalid_format",
"message": "Invalid email address"
},
{
"field": "age",
"code": "invalid_type",
"message": "Invalid input: expected number, received string"
}
]
}{
"type": "https://docs.appstrate.dev/errors/forbidden",
"title": "Forbidden",
"status": 403,
"detail": "Insufficient permissions",
"code": "forbidden",
"request_id": "req_abc123"
}{
"type": "https://docs.appstrate.dev/errors/not-found",
"title": "Not Found",
"status": 404,
"detail": "Resource not found",
"code": "not_found",
"request_id": "req_abc123"
}{
"type": "https://docs.appstrate.dev/errors/connect-unavailable",
"title": "Service Unavailable",
"status": 503,
"detail": "This connection method is unavailable on this deployment. Contact your administrator.",
"code": "connect_unavailable",
"request_id": "req_abc123"
}{
"type": "https://docs.appstrate.dev/errors/timeout",
"title": "Gateway Timeout",
"status": 504,
"detail": "The connection attempt timed out after 60000ms — the login did not complete in time. Please try again.",
"code": "timeout",
"request_id": "req_def456"
}