Add multiple domains and redirects to an existing install

POST

/installs/{install_id}/domains/bulk

Adds multiple domains and redirects to a specific install

Authorizations

• basicAuth

Parameters

Path Parameters

install_id

required

string format: uuid

ID of install

Request Body

Properties

• domains - required - array of domains to be created, min size: 1, max size: 20
  • items:
    • name - required - The name of the new domain (or redirect)
    • redirect_to - optional - Name of the domain to set redirect to

object

domains

required

Array<object>

>= 1 items <= 20 items

object

name

required

string

redirect_to

string

Example

{
  "domains": [
    {
      "name": "example.com"
    },
    {
      "name": "www.example.com",
      "redirect_to": "example.com"
    }
  ]
}

Responses

201

Created

object

id

required

string format: uuid

Example

e41fa98f-ea80-4654-b229-a9b765d0863a

name

required

string

Example

example.com

duplicate

required

boolean

primary

required

boolean

Example

true

redirects_to

object

id

string format: uuid

Example

e41fa98f-ea80-4006-b229-a9b765d0863a

name

string

Example

redirect.com

400

Bad Request

object

message

required

A message regarding the error that occurred on the server

string

Example

Invalid Site: Name cannot be empty.

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

Example

Site

field

required

(Optional) The specific field associated with the error

string

Example

name

type

required

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

string

Example

invalid_value

code

required

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

string

Example

too_long

message

required

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

string

Example

Name is too long (maximum is 40 characters)

401

Authentication Error

object

message

required

A message regarding the error that occurred on the server

string

Example

Bad Credentials

documentation_url

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

string

403

Not authorized

object

message

required

A message regarding the error that occurred on the server

string

Example

You don't have permission to perform that action

documentation_url

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

string

429

Too many requests

503

Service unavailable