| 75 | |
| 76 | /* eslint-disable-next-line no-unused-vars */ |
| 77 | export default function ipRouter(envConfig) { |
| 78 | /** |
| 79 | * @swagger |
| 80 | * |
| 81 | * security: |
| 82 | * - APIKeyHeader: [] |
| 83 | * |
| 84 | * tags: |
| 85 | * - name: IP - General query |
| 86 | * description: Find records based on various mutually exclusive properties. |
| 87 | * - name: IP - General count query |
| 88 | * description: Count records based on various mutually exclusive properties. |
| 89 | * |
| 90 | * /api/v1.0/ips: |
| 91 | * get: |
| 92 | * # Operation-specific security: |
| 93 | * security: |
| 94 | * - APIKeyHeader: [] |
| 95 | * description: Find records based on various mutually exclusive properties. If no parameters are provided, then all IPs are returned. Use limit+page to paginate the results. |
| 96 | * tags: [IP - General query] |
| 97 | * produces: |
| 98 | * - application/json |
| 99 | * parameters: |
| 100 | * - name: ip |
| 101 | * type: string |
| 102 | * required: false |
| 103 | * description: The IPv4 or IPv6 record to retrieve |
| 104 | * in: query |
| 105 | * - name: domain |
| 106 | * type: string |
| 107 | * required: false |
| 108 | * description: Retrieve IP information for the specified domain |
| 109 | * in: query |
| 110 | * - name: zone |
| 111 | * type: string |
| 112 | * required: false |
| 113 | * description: Retrieve IP information for the specified zone |
| 114 | * in: query |
| 115 | * - name: host_cidr |
| 116 | * type: string |
| 117 | * required: false |
| 118 | * description: Retrieve IP information for specified host (TRACKED, AWS, AZURE) CIDR |
| 119 | * in: query |
| 120 | * - name: ip_version |
| 121 | * type: string |
| 122 | * required: false |
| 123 | * description: Retrieve IP information for either IPv4 or IPv6. Please specify either '4' or '6' |
| 124 | * in: query |
| 125 | * - name: partner |
| 126 | * type: string |
| 127 | * required: false |
| 128 | * description: A specific hosting partner |
| 129 | * enum: ["AWS", "AZURE", "TRACKED"] |
| 130 | * in: query |
| 131 | * - name: managed_hosts |
| 132 | * type: string |
| 133 | * required: false |
| 134 | * description: Retrieve only the IP addresses that Marinus is certain that within a controlled data center or cloud provider. Set to 1. |