/2016-07/deployments/:id/portals

Gets a list of portals associated with a deployment.

The endpoint returns all portals associated with the deployment given in the parameters. It returns an _embedded object with a portals key whose value is an array of portals. The key/values of the object are detailed below.

Returned JSON

portals object key

Description

id

The portal id.

name

The name associated with the portal.

type

The type of portal—typically haproxy or ssl.

internal_ip

The ip address associated with the portal.

zone

The zone where the portal is located.

hostname

The portal's hostname.

ssl_enabled

Whether or not the portal is SSL enabled. Only applies to Redis haproxies as they can have both SSL enabled and non-SSL enabled portals.

📘

Deployments with specialized portals

MongoDB and RethinkDB TCP portals are specialized configurations for those database types that have knowledge of your configurations, member shards, and nodes. These portals will return mongodb and rethink as their type.

Language
Authentication
Header
Click Try It! to start a request and see the response here!