Skip to content

Mark a host as a dev environment

POST
/v1/project/dev-hosts
curl --request POST \
--url https://api.proxymail.qa/v1/project/dev-hosts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "host": "example" }'

Adds a host to the project’s dev environments, as in Project settings: links to it in emails (an app running on localhost:3000, say) then pass the local-links check of /checks instead of failing it. Links to an unmarked localhost still fail.

Media typeapplication/json
object
host
required

Host and port, or a page URL, such as localhost:3000.

string
<= 300 characters

Example generated

{
"host": "example"
}

The project’s dev hosts

Media typeapplication/json
object
dev_hosts
Array<string>

Example generated

{
"dev_hosts": [
"example"
]
}

An error

Media typeapplication/json
object
error
string
message
string

Example generated

{
"error": "example",
"message": "example"
}

An error

Media typeapplication/json
object
error
string
message
string

Example generated

{
"error": "example",
"message": "example"
}

An error

Media typeapplication/json
object
error
string
message
string

Example generated

{
"error": "example",
"message": "example"
}