Type Alias ListIPsRequest

ListIPsRequest: {
    attached?: boolean;
    isIpv6?: boolean;
    macAddress?: string;
    orderBy?: IPAM.v1.ListIPsRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    privateNetworkId?: string;
    projectId?: string;
    region?: Region;
    resourceId?: string;
    resourceName?: string;
    resourceType?: ResourceType;
    resourceTypes?: ResourceType[];
    subnetId?: string;
    tags?: string[];
    vpcId?: string;
    zonal?: string;
}

Type declaration

  • Optionalattached?: boolean

    Defines whether to filter only for IPs which are attached to a resource.

  • OptionalisIpv6?: boolean

    Defines whether to filter only for IPv4s or IPv6s.

  • OptionalmacAddress?: string

    MAC address to filter for. Only IPs attached to a resource with this MAC address will be returned.

  • OptionalorderBy?: IPAM.v1.ListIPsRequestOrderBy

    Sort order of the returned IPs.

  • OptionalorganizationId?: string

    Organization ID to filter for. Only IPs belonging to this Organization will be returned.

  • Optionalpage?: number

    Page number to return, from the paginated results.

  • OptionalpageSize?: number

    Maximum number of IPs to return per page.

  • OptionalprivateNetworkId?: string

    Only IPs that are private, and in this Private Network, will be returned.

    One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set.

  • OptionalprojectId?: string

    Project ID to filter for. Only IPs belonging to this Project will be returned.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • OptionalresourceId?: string

    Resource ID to filter for. Only IPs attached to this resource will be returned.

  • OptionalresourceName?: string

    Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned.

  • OptionalresourceType?: ResourceType

    Resource type to filter for. Only IPs attached to this type of resource will be returned.

  • OptionalresourceTypes?: ResourceType[]

    Resource types to filter for. Only IPs attached to these types of resources will be returned.

  • OptionalsubnetId?: string

    Only IPs inside this exact subnet will be returned.

    One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set.

  • Optionaltags?: string[]

    Tags to filter for, only IPs with one or more matching tags will be returned.

  • OptionalvpcId?: string

    Only IPs owned by resources in this VPC will be returned.

  • Optionalzonal?: string

    Zone to filter for. Only IPs that are zonal, and in this zone, will be returned.

    One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set.

Settings