Skip to content

Connect Website Hosting

POST
/website-editor/connect

Connect the org’s website hosting account. FREE.

The credentials are validated against the provider before they are stored, so a wrong token is a 400 rather than a broken connection. Replaces any existing connection. The token is WRITE-ONLY - no response carries it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Connect the org’s website hosting account. The token is write-only.

object
account_id
required

The hosting provider’s account id.

string
api_token
required

An API token for that account. Never returned.

string
project_name
Any of:
string

Responses

200

Successful Response

object
data
required

The hosting connection, without its credential.

object
account_id
Any of:
string
connected
required
boolean
created_at
Any of:
string format: date-time
id
Any of:
string
last_synced_at
Any of:
string format: date-time
project_name
Any of:
string
status
Any of:
string
updated_at
Any of:
string format: date-time
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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