https://github.com/nl2go/hetzner-robot-api-mock

A HTTP server based on JSON Server that mocks Hetzner Robot API
https://github.com/nl2go/hetzner-robot-api-mock

docker-compose dockerfile hetzner hetzner-robot-api json-server mocks

Last synced: about 1 year ago
JSON representation

A HTTP server based on JSON Server that mocks Hetzner Robot API

• Host: GitHub
• URL: https://github.com/nl2go/hetzner-robot-api-mock
• Owner: nl2go
• License: mit
• Created: 2019-11-13T15:17:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T19:06:17.000Z (over 3 years ago)
• Last Synced: 2025-04-05T09:24:53.426Z (about 1 year ago)
• Topics: docker-compose, dockerfile, hetzner, hetzner-robot-api, json-server, mocks
• Language: JavaScript
• Homepage:
• Size: 445 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![Travis (.org) branch](https://img.shields.io/travis/nl2go/hetzner-robot-api-mock/master)](https://travis-ci.org/nl2go/hetzner-robot-api-mock)

[![Codecov](https://img.shields.io/codecov/c/github/nl2go/hetzner-robot-api-mock)](https://codecov.io/gh/nl2go/hetzner-robot-api-mock)

![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/nl2go/hetzner-robot-api-mock)

[![Docker Pulls](https://img.shields.io/docker/pulls/nl2go/hetzner-robot-api-mock)](https://hub.docker.com/r/nl2go/hetzner-robot-api-mock)

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/nl2go/hetzner-robot-api-mock)](https://hub.docker.com/repository/docker/nl2go/hetzner-robot-api-mock/tags?page=1)

# Hetzner Robot API Mock

A HTTP server based on [JSON Server](https://github.com/typicode/json-server) that mocks [Hetzner Robot API](https://robot.your-server.de/doc/webservice/en.html).

## Implemented Endpoints

| Name | API Reference |

|------|------|

| `GET /reset` | [get-reset](https://robot.your-server.de/doc/webservice/de.html#reset) |

| `GET /reset/{server-ip}` | [get-reset-server-ip](https://robot.your-server.de/doc/webservice/de.html#get-reset-server-ip) |

| `POST /reset/{server-ip}` | [post-reset-server-ip](https://robot.your-server.de/doc/webservice/de.html#post-reset-server-ip) |

| `GET /boot/{server-ip}/rescue` | [get-boot-server-ip-rescue](https://robot.your-server.de/doc/webservice/de.html#get-boot-server-ip-rescue) |

| `POST /boot/{server-ip}/rescue` | [post-boot-server-ip-rescue](https://robot.your-server.de/doc/webservice/de.html#post-boot-server-ip-rescue) |

| `DELETE /boot/{server-ip}/rescue` | [delete-boot-server-ip-rescue](https://robot.your-server.de/doc/webservice/de.html#delete-boot-server-ip-rescue) |

| `GET /firewall/{server-ip}` | [get-firewall-server-ip](https://robot.your-server.de/doc/webservice/de.html#get-firewall-server-ip) |

| `POST /firewall/{server-ip}` | [post-firewall-server-ip](https://robot.your-server.de/doc/webservice/de.html#post-firewall-server-ip) |

| `DELETE /firewall/{server-ip}` | [delete-firewall-server-ip](https://robot.your-server.de/doc/webservice/de.html#delete-firewall-server-ip) |

| `GET /firewall/template` | [get-firewall-template](https://robot.your-server.de/doc/webservice/de.html#get-firewall-template) |

| `POST /firewall/template` | [post-firewall-template](https://robot.your-server.de/doc/webservice/de.html#post-firewall-template) |

| `GET /firewall/template/{template-id}` | [get-firewall-template-template-id](https://robot.your-server.de/doc/webservice/de.html#get-firewall-template-template-id) |

| `POST /firewall/template/{template-id}` | [post-firewall-template-template-id](https://robot.your-server.de/doc/webservice/de.html#post-firewall-template-template-id) |

| `DELETE /firewall/template/{template-id}` | [delete-firewall-template-template-id](https://robot.your-server.de/doc/webservice/de.html#delete-firewall-template-template-id) |

| `GET /vswitch` | [get-vswitch](https://robot.your-server.de/doc/webservice/de.html#get-vswitch) |

| `POST /vswitch` | [post-vswitch](https://robot.your-server.de/doc/webservice/de.html#post-vswitch) |

| `GET /vswitch/{vswitch-id}` | [get-vswitch-vswitch-id](https://robot.your-server.de/doc/webservice/de.html#get-vswitch-vswitch-id) |

| `POST /vswitch/{vswitch-id}` | [post-vswitch-vswitch-id](https://robot.your-server.de/doc/webservice/de.html#post-vswitch-vswitch-id) |

| `DELETE /vswitch/{vswitch-id}` | [delete-vswitch-vswitch-id](https://robot.your-server.de/doc/webservice/de.html#delete-vswitch-vswitch-id) |

| `GET /server/{server-ip}` | [get-server-server-ip](https://robot.your-server.de/doc/webservice/de.html#get-server-server-ip) |

| `POST /server/{server-ip}` | [post-server-server-ip](https://robot.your-server.de/doc/webservice/de.html#post-server-server-ip) |

| `GET /key` | [get-key](https://robot.your-server.de/doc/webservice/de.html#get-key) |

| `POST /key` | [post-key](https://robot.your-server.de/doc/webservice/de.html#post-key) |

| `GET /key/{fingerprint}` | [get-key-fingerprint](https://robot.your-server.de/doc/webservice/de.html#get-key-fingerprint) |

| `POST /key/{fingerprint}` | [post-key-fingerprint](https://robot.your-server.de/doc/webservice/de.html#post-key-fingerprint) |

| `DELETE /key/{fingerprint}` | [delete-key-fingerprint](https://robot.your-server.de/doc/webservice/de.html#delete-key-fingerprint) |

## Authentication

Use username `robot` and password `secret` to authenticate.

## Development

Bootstrap

    npm install

    

Run tests

    

    npm test

    

Run locally

    cd /src/ && node index.js

Run locally built image

    docker-compose up

Rebuild image

    docker-compose build

## Maintainers

- [dirkaholic](https://github.com/dirkaholic)

- [build-failure](https://github.com/build-failure)

## License

See the [LICENSE.md](LICENSE.md) file for details