Skip to main content

Retrieves a list of IP Pools for the specified private gateway

GET 
https://api.spectrocloud.com/v1/overlords/vsphere/:uid/pools

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

Retrieves a list of IP Pools for the specified private gateway

Request​

Path Parameters

    uid stringrequired

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses​

(empty)

Schema
    items object[]required
  • Array [
    • metadata object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set

    property name*string
    creationTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    deletionTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    labels object

    Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    property name*string
    lastModifiedTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    namestring

    Name of the resource

    uidstring

    UID is the unique identifier generated for the resource. This is not an input field for any request.

    Populated by the system. Read-only.

    spec object
    pool object

    Pool defines IP ranges or with CIDR for available IPs Gateway, Prefix and Nameserver if provided, will overwrite values in IPPool

    endstring

    End is the last IP address that can be rendered. It is used as a validation that the rendered IP is in bound.

    gatewaystring

    Gateway is the gateway ip address

    nameserver object

    Nameserver provide information for dns resolvation

    addressesstring[]
    searchstring[]
    prefixint32

    Prefix is the mask of the network as integer (max 128)

    startstring

    Start is the first ip address that can be rendered

    subnetstring

    Subnet is used to validate that the rendered IP is in bounds. eg: 192.168.0.0/24 If Start value is not given, start value is derived from the subnet ip incremented by 1 (start value is 192.168.0.1 for subnet 192.168.0.0/24)

    priavetGatewayUidstring
    restrictToSingleClusterboolean

    if true, restricts this IP pool to be used by single cluster at any time

    status object

    IP Pool status

    allottedIpsstring[]
    associatedClustersstring[]
    inUseboolean
  • ]
curl -L -X GET 'https://api.spectrocloud.com/v1/overlords/vsphere/:uid/pools' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>'
Request Collapse all
Base URL
https://api.spectrocloud.com
Auth
Parameters
— pathrequired
— header