ACacquia
Environments

Retrieves a collection of egress IPs for the specified environment.

get/environments/{environmentId}/eips

Request

Path parameters

environmentIdstring required

Unique identifier for the environment.

Query parameters

offsetinteger
Example:20

The number of items to skip before starting to collect the result set.

limitinteger
Example:10

The maximum number of items to return per page.

Response

Egress IP collection

countinteger required

The number of items in the current page

totalinteger required

The total number of items available

Example response

{
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources?offset=2&limit=2"
    },
    "prev": {
      "href": "https://api.acquia.com/v3/resources?offset=0&limit=2"
    },
    "next": {
      "href": "https://api.acquia.com/v3/resources?offset=4&limit=2"
    },
    "offset": {
      "href": "https://api.acquia.com/v3/resources{?offset}",
      "templated": true
    },
    "limit": {
      "href": "https://api.acquia.com/v3/resources{?limit}",
      "templated": true
    }
  },
  "count": 2,
  "total": 6,
  "pagination": {
    "total": 6,
    "limit": 2,
    "offset": 2
  },
  "_embedded": {
    "items": [
      {
        "id": "456e4567-e89b-11d3-a789-426614174000",
        "name": "Resource 3",
        "_links": {
          "self": {
            "href": "https://api.acquia.com/v3/resources/456e4567-e89b-11d3-a789-426614174000"
          }
        }
      },
      {
        "id": "789e4567-e89b-11d3-a789-426614174000",
        "name": "Resource 4",
        "_links": {
          "self": {
            "href": "https://api.acquia.com/v3/resources/789e4567-e89b-11d3-a789-426614174000"
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.