WordPress

Connect a WordPress site hosted elsewhere with a WordPress Application Password (checked against the site's REST API first, stored encrypted, never returned). Without a paid plan this uses the wordpress.connect_external add-on: 10 Build Credits, once per site

post/wordpress/connections

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/wordpress/connections
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Query parameters

orgIdstring

Organization id (required when you belong to several)

Request body

siteUrlstring required

The site's address, e.g. https://example.com

usernamestring required

The WordPress user the Application Password belongs to

applicationPasswordstring required

Sent once, stored encrypted, never shown again

Response

Connected

idstring uuid required
organizationIdstring uuid required
siteUrlstring required
siteNamestring nullable required
usernamestring required
userDisplayNamestring nullable required
status'active' | 'error' | 'disconnected' required
seoPlugin'yoast' | 'rankmath' | 'null' nullable required
lastVerifiedAtstring nullable required

ISO-8601 timestamp

lastErrorstring nullable required
createdAtstring required

ISO-8601 timestamp

createdBystring uuid nullable required
disconnectedAtstring nullable required

ISO-8601 timestamp

authKind'application_password' | 'connector'
scopesstring[]
projectIdstring uuid nullable
pluginVersionstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.