hcloud-ts

a TypeScript library for the Hetzner Cloud API

project status

This is still very much in progress. A lot of the Hetzner API calls are yet to be implemented. Stay tuned ;)

More precisely, the following entities are available to work with ATM:

• zones
• records

prerequisites

You need ENV variable HETZNER_API_TOKEN set. You can do so:

export HETZNER_API_TOKEN="8try83ru3908ru329r32ur390ru"

Where 8try83ru3908ru329r32ur390ru is the value of HETZNER_API_TOKEN.

arguments

General invocation of the CLI tool:

npx tsx ./index.ts \
  {{entity option}} \
  {{mode option}} \
  {{optional - resource ID}} \
  {{optional - data to set}}

Available arguments for the CLI:

entity option:
  --zone    -  retrieves DNS zones
  --record  -  retrieves DNS records


mode option:
  --get-all  -  get all items
  --get-one  -  get one item (based on ID provided)
  --update   -  update an item
  --create   -  create a new item
  --delete   -  delete an item


optional - resource ID:
  --record-id {{UID}} -  ID of the record to get/update/delete
  --zone-id {{UID}}   -  ID of the zone to get/update/delete


optional - data to set:
  # In order to create/update an item, you need to set property values.
  # You can do so like so:

  --set-PROPERTY-NAME PROPERTY-VALUE

  # The above will set 'PROPERTY_NAME' to 'PROPERTY_VALUE'. These are case sensitive!
  # For example:

  --set-ttl 600

  # If the value contains spaces, put quotes around it:

  --set-value "Hello, world!"

example invocation

Example of how to run the CLI:

npx tsx ./index.ts \
  --record \
  --update \
  --record-id "fc249227f4ae170dafa99394971da92b" \
  --set-name "orgid-v2"

The above command will update the zone record with ID fc249227f4ae170dafa99394971da92b. It will set the name property of that record to the value orgid-v2.

debugging

For debugging purposes, you may wish to use a mock server. This way the CLI will not access the actual HETZNER API, but your own local mock server. You can achieve this by setting a custom API base URL address. Just export the environment variable HETZNER_API_BASE_URL like so:

export HETZNER_API_BASE_URL="http://localhost:8000"

Make sure your mock server is listening on port 8000.

---

license

The project 'hcloud-ts' is licensed under the MIT License.

See LICENSE for more details.

The latest source code can be retrieved from one of several mirrors:

1. github.com/valera-rozuvan/hcloud-ts

2. gitlab.com/valera-rozuvan/hcloud-ts

3. git.rozuvan.net/hcloud-ts

Copyright (c) 2022-2023 Valera Rozuvan