Documentation menu

API Reference

Collections Resource

POST /api/plugin/collections/register

Register

Request body

application/json 
{
  "collections": [
    {
      "name": "string",
      "key": "string",
      "indexes": [
        {
          "field": "string",
          "type": "string"
        }
      ]
    }
  ]
}

Responses

  • 200 OK
  • 400 Bad Request

Request

~
curl -X POST https://api.hivescale.dev/api/plugin/collections/register \
  -H "X-Hive-Api-Key: $HIVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"collections":[{"name":"string","key":"string","indexes":[{"field":"string","type":"string"}]}]}'
HttpClient client = HttpClient.newHttpClient();

String body = "{\"collections\":[{\"name\":\"string\",\"key\":\"string\",\"indexes\":[{\"field\":\"string\",\"type\":\"string\"}]}]}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.hivescale.dev/api/plugin/collections/register"))
    .header("X-Hive-Api-Key", apiKey)
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response =
    client.send(request, HttpResponse.BodyHandlers.ofString());
GET /api/plugin/collections/{collection}/by/{field}

Query By

Parameters

  • collection string path required
  • field string path required
  • limit integer query
  • value string query

Responses

  • 200 OK

Request

~
curl -X GET https://api.hivescale.dev/api/plugin/collections/{collection}/by/{field}?limit=0&value=value \
  -H "X-Hive-Api-Key: $HIVE_API_KEY"
HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.hivescale.dev/api/plugin/collections/{collection}/by/{field}?limit=0&value=value"))
    .header("X-Hive-Api-Key", apiKey)
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response =
    client.send(request, HttpResponse.BodyHandlers.ofString());
POST /api/plugin/collections/{collection}/mget

Mget

Parameters

  • collection string path required

Request body

application/json 
{
  "ids": [
    "string"
  ]
}

Responses

  • 200 OK
  • 400 Bad Request

Request

~
curl -X POST https://api.hivescale.dev/api/plugin/collections/{collection}/mget \
  -H "X-Hive-Api-Key: $HIVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'
HttpClient client = HttpClient.newHttpClient();

String body = "{\"ids\":[\"string\"]}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.hivescale.dev/api/plugin/collections/{collection}/mget"))
    .header("X-Hive-Api-Key", apiKey)
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response =
    client.send(request, HttpResponse.BodyHandlers.ofString());
GET /api/plugin/collections/{collection}/page/{field}

Page

Parameters

  • collection string path required
  • field string path required
  • cursor string query
  • limit integer query
  • order string query

Responses

  • 200 OK

Request

~
curl -X GET https://api.hivescale.dev/api/plugin/collections/{collection}/page/{field}?cursor=value&limit=0&order=value \
  -H "X-Hive-Api-Key: $HIVE_API_KEY"
HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.hivescale.dev/api/plugin/collections/{collection}/page/{field}?cursor=value&limit=0&order=value"))
    .header("X-Hive-Api-Key", apiKey)
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response =
    client.send(request, HttpResponse.BodyHandlers.ofString());
GET /api/plugin/collections/{collection}/range/{field}

Range

Parameters

  • collection string path required
  • field string path required
  • limit integer query
  • max number query
  • min number query
  • order string query

Responses

  • 200 OK

Request

~
curl -X GET https://api.hivescale.dev/api/plugin/collections/{collection}/range/{field}?limit=0&max=0&min=0&order=value \
  -H "X-Hive-Api-Key: $HIVE_API_KEY"
HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.hivescale.dev/api/plugin/collections/{collection}/range/{field}?limit=0&max=0&min=0&order=value"))
    .header("X-Hive-Api-Key", apiKey)
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response =
    client.send(request, HttpResponse.BodyHandlers.ofString());
GET /api/plugin/collections/{collection}/top/{field}

Top

Parameters

  • collection string path required
  • field string path required
  • limit integer query
  • order string query

Responses

  • 200 OK

Request

~
curl -X GET https://api.hivescale.dev/api/plugin/collections/{collection}/top/{field}?limit=0&order=value \
  -H "X-Hive-Api-Key: $HIVE_API_KEY"
HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.hivescale.dev/api/plugin/collections/{collection}/top/{field}?limit=0&order=value"))
    .header("X-Hive-Api-Key", apiKey)
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response =
    client.send(request, HttpResponse.BodyHandlers.ofString());
GET /api/plugin/collections/{collection}/{id}

Get

Parameters

  • collection string path required
  • id string path required

Responses

  • 200 OK

Request

~
curl -X GET https://api.hivescale.dev/api/plugin/collections/{collection}/{id} \
  -H "X-Hive-Api-Key: $HIVE_API_KEY"
HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.hivescale.dev/api/plugin/collections/{collection}/{id}"))
    .header("X-Hive-Api-Key", apiKey)
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response =
    client.send(request, HttpResponse.BodyHandlers.ofString());
PUT /api/plugin/collections/{collection}/{id}

Put

Parameters

  • collection string path required
  • id string path required

Request body

application/json 
"string"

Responses

  • 200 OK

Request

~
curl -X PUT https://api.hivescale.dev/api/plugin/collections/{collection}/{id} \
  -H "X-Hive-Api-Key: $HIVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '"string"'
HttpClient client = HttpClient.newHttpClient();

String body = "\"string\"";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.hivescale.dev/api/plugin/collections/{collection}/{id}"))
    .header("X-Hive-Api-Key", apiKey)
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response =
    client.send(request, HttpResponse.BodyHandlers.ofString());
DELETE /api/plugin/collections/{collection}/{id}

Delete

Parameters

  • collection string path required
  • id string path required

Responses

  • 200 OK

Request

~
curl -X DELETE https://api.hivescale.dev/api/plugin/collections/{collection}/{id} \
  -H "X-Hive-Api-Key: $HIVE_API_KEY"
HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.hivescale.dev/api/plugin/collections/{collection}/{id}"))
    .header("X-Hive-Api-Key", apiKey)
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response =
    client.send(request, HttpResponse.BodyHandlers.ofString());