Add support for creating whitelist entries (POST /v2/whitelist/{app}/)

Author: Jonathan Visser

src/Service/Whitelist.php

@@ -33,4 +33,26 @@ public function getList(string $app, array $params = []): array
 
         return $this->client->getJsonFromResponse($response);
     }
+
+    /**
+     * Add a whitelist entry for the Hypernode.
+     *
+     * @param string $app Name of the Hypernode
+     * @param array $data Whitelist entry data, requires at least the key `ip`.
+     *  Optional keys are `type` (database, ftp, phpmyadmin, ssh or waf,
+     *  defaults to database) and `description`.
+     * @return array The created whitelist entry
+     * @throws HypernodeApiClientException
+     * @throws HypernodeApiServerException
+     */
+    public function create(string $app, array $data): array
+    {
+        $url = sprintf(self::V2_WHITELIST_URL, $app);
+
+        $response = $this->client->api->post($url, [], json_encode($data));
+
+        $this->client->maybeThrowApiExceptions($response);
+
+        return $this->client->getJsonFromResponse($response);
+    }
 }

tests/unit/Service/WhitelistTest.php

@@ -72,4 +72,54 @@ public function testGetListRaisesServerExceptions()
 
         $this->client->whitelist->getList('johndoe');
     }
+
+    public function testCreate()
+    {
+        $entryData = [
+            'ip' => '1.2.3.4',
+            'type' => 'waf',
+            'description' => 'Office IP',
+        ];
+        $createdEntry = array_merge($entryData, [
+            'id' => 1234,
+            'created' => '2026-07-15T12:00:00Z',
+            'app' => 'johndoe',
+        ]);
+        $this->responses->append(
+            new Response(200, [], json_encode($createdEntry)),
+        );
+
+        $result = $this->client->whitelist->create('johndoe', $entryData);
+
+        $request = $this->responses->getLastRequest();
+        $this->assertEquals('POST', $request->getMethod());
+        $this->assertEquals('/v2/whitelist/johndoe/', $request->getUri());
+        $this->assertJson((string)$request->getBody());
+        $this->assertEquals($entryData, json_decode((string)$request->getBody(), true));
+        $this->assertEquals($createdEntry, $result);
+    }
+
+    public function testCreateRaisesClientExceptions()
+    {
+        $badRequestResponse = new Response(400, [], json_encode([
+            'non_field_errors' => ['Your request was invalid.']
+        ]));
+        $this->responses->append($badRequestResponse);
+
+        $this->expectExceptionObject(new HypernodeApiClientException($badRequestResponse));
+
+        $this->client->whitelist->create('johndoe', ['ip' => '1.2.3.4']);
+    }
+
+    public function testCreateRaisesServerExceptions()
+    {
+        $badRequestResponse = new Response(500, [], json_encode([
+            'non_field_errors' => ['Something went wrong processing your request.']
+        ]));
+        $this->responses->append($badRequestResponse);
+
+        $this->expectExceptionObject(new HypernodeApiServerException($badRequestResponse));
+
+        $this->client->whitelist->create('johndoe', ['ip' => '1.2.3.4']);
+    }
 }