ListPublicIps

GET {{baseUrl}}/publicIps?limit=801&scope=AVAILABILITY_DOMAIN&availabilityDomain=officia sed&lifetime=RESERVED&compartmentId={{compartment_ocid}}

Lists the PublicIp objects in the specified compartment. You can filter the list by using query parameters.

To list your reserved public IPs: * Set scope = REGION (required) * Leave the availabilityDomain parameter empty * Set lifetime = RESERVED

To list the ephemeral public IPs assigned to a regional entity such as a NAT gateway: * Set scope = REGION (required) * Leave the availabilityDomain parameter empty * Set lifetime = EPHEMERAL

To list the ephemeral public IPs assigned to private IPs: * Set scope = AVAILABILITY_DOMAIN (required) * Set the availabilityDomain parameter to the desired availability domain (required) * Set lifetime = EPHEMERAL

Note: An ephemeral public IP assigned to a private IP is always in the same availability domain and compartment as the private IP.

Request Params

Example: 50 | | page | string | | For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination. | | scope | string | | (Required) Whether the public IP is regional or specific to a particular availability domain.

• REGION: The public IP exists within a region and is assigned to a regional entity (such as a NatGateway), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs have scope = REGION, as do ephemeral public IPs assigned to a regional entity.

• AVAILABILITY_DOMAIN: The public IP exists within the availability domain of the entity it's assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN. | | availabilityDomain | string | | The name of the availability domain.

Example: Uocm:PHX-AD-1 | | lifetime | string | | A filter to return only public IPs that match given lifetime. | | compartmentId | string | | (Required) The OCID of the compartment. | | publicIpPoolId | string | | A filter to return only resources that belong to the given public IP pool. |

HEADERS

RESPONSES

status: OK

[{"assignedEntityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"assignedEntityType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"availabilityDomain":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ipAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifetime":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"privateIpId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"publicIpPoolId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"scope":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"assignedEntityId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"assignedEntityType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"availabilityDomain":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ipAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifetime":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"privateIpId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"publicIpPoolId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"scope":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]