AUTHENTICATION
Connection is only allowed via SSL.
Authentication is performed with HTTP Basic authentication. Usernames and secrets can be managed online.
BASE URL
REQUESTS AND RESPONSES
POST requests must provide data in JSON format, in UTF-8. (Nothing beyond ASCII should be required, as of this writing.)
Any response body, if given, will also be JSON.
Error bodies may include these two properties:
error
This is a string describing what went wrong. This will always appear.
guidIn the event of an internal error, this string will uniquely identify the error and can be provided to Pobox customer support to aid in diagnosing problems. Don't expect this to come up.
ENDPOINTS
/routes
<GET>: The response is an Object. Each property is an alias. Each value is the settings for that alias, an Object containing at least one property: . Successful response is code 200.
<POST>: The request data is an Object. Each property is an alias. Each value is the settings for that alias, an Object containing exactly one property: . To delete the routing for an alias, supply as its forwarding address. Successful response is code 200.
Example:
POST
/v2/routes
{ "alias@yourdomain.com":{"fwd":"forward@example.com"},
"another@yourdomain.com":{"fwd":"destination@another.mil"}
}
<PUT>: Not yet implemented, and may not ever be. This behaves like POST, but also deletes all aliases not provided.
/routes/count
<GET>: This returns an Object domain names as properties and integers as values. The value for each property is the count of active routes at the named domain. /route/ : This returns the settings for the requested alias an an Object. The settings are an Object containing at least one property: . Successful response is code 200.
<PUT>: This updates the settings for the alias. The given request data is an Object with the required property . If , the alias is deleted. Otherwise, its routing is updated.
Example:
PUT /v2/route/alias@yourdomain.com
{"fwd":"forward@example.com"}
<DELETE>: This behaves like a PUT request with a null fwd.