Generate a shareable Entri Connect URL for DNS configuration

POST

/installs/{install_id}/domains/{domain_id}/sharing_link

curl --request POST \
  --url https://api.wpengineapi.com/v1/installs/example/domains/example/sharing_link \
  --header 'Authorization: Basic <credentials>'

Generates a shareable Entri Connect URL that can be sent to anyone with Domain Registry access to complete DNS configuration. When a user opens the URL, they’ll be asked to sign into their Domain Registry and complete DNS verification and configuration to point the domain to WP Engine. The domain must be on the Advanced Network (AN) or Global Edge Security (GES) network type.

Each call generates a new share link. There is no idempotency token, so you should treat the returned URL as the artifact and re-share it rather than regenerate to avoid creating orphan share links.

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

domain_id

required

string format: uuid

ID of domain

Responses

200

Sharing link generated successfully

Media type application/json

object

url

required

A shareable Entri Connect URL for DNS configuration

string format: uri

Example

{
  "url": "https://app.goentri.com/share/dd339cf05f2646539e79251f8e62f0c5"
}

400

Bad Request

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

errors

An array of error objects describing specific errors that arose when servicing the request

Array<object>

object

resource

required

The name of the resource that was being processed when the error occurred

string

field

required

(Optional) The specific field associated with the error

string

type

required

(Optional) A type associated with the error. invalid_value, access_error, value_unavailable

string

code

required

(Optional) A machine code relating to the error that occurred with the field and resource

string

message

required

(Optional) A human-readable message relating to the error that occurred with the field and resource

string

Example

{
  "message": "Invalid Site: Name cannot be empty.",
  "errors": [
    {
      "resource": "Site",
      "field": "name",
      "type": "invalid_value",
      "code": "too_long",
      "message": "Name is too long (maximum is 40 characters)"
    }
  ]
}

401

Authentication Error

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "Bad Credentials"
}

403

Not authorized

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "You don't have permission to perform that action"
}

404

Not found

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "Not Found"
}

429

Too many requests

Media type application/json

500

Internal server error

Media type application/json

object

message

required

A message regarding the error that occurred on the server

string

Example

{
  "message": "An unexpected error occurred, please try again in a few minutes"
}

502

An invalid response was received from an upstream server

Media type application/json

503

Service unavailable

Media type application/json