API Reference

This section provides information in order to use the Hive Public APIs. As a reminder, the Hive APIs are REST based APIs.

HTTP verbs

Hive APIs try to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

PATCH

Used to update an existing resource, including partial updates

DELETE

Used to delete an existing resource

HTTP status codes

Hive APIs try to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.

Status code Usage

200 OK

The request completed successfully

201 Created

A new resource has been created successfully. The resource’s URI is available from the response’s Location header

204 No Content

An update to an existing resource has been applied successfully

400 Bad Request

The request was malformed. The response body will include an error providing further information

401 Unauthorized

An authentication is required to access this resource. Applications should trigger a reauthentication when getting this error.

403 Unauthorized

Authentication was accepted but the current user has no access rights to this resource.

404 Not Found

The requested resource did not exist

500 Server Error

The request seems right, but a problem occurred on the server. The client cannot do anything about it

Hypermedia

Hive APIs use hypermedia and resources include links to other resources in their responses. Responses are in Hypertext Application Language (HAL) format. Links can be found beneath the _links key. Users of the API should not create URIs themselves, instead they should use the above-described links to navigate from resource to resource.