Wolkra

Wolkra API

Updated

The Wolkra API is a REST API at https://api.wolkra.com/v1 that lets you create and manage servers, volumes, networks, firewalls and load balancers from your own code. Requests are authenticated with project-scoped tokens that you can limit to read-only, to certain IP addresses and to a fixed lifetime.

What the API covers

The API mirrors what you do in the console. Common tasks include:

Everything uses JSON over HTTPS, with standard HTTP methods and status codes.

API tokens

Tokens are created in the console under your project's settings.

Option What it does
Project scope A token works for one project only
wk_ prefix Makes Wolkra tokens easy to spot in code and secret scanners
Read or read/write Read-only tokens can list and inspect, read/write tokens can change things
IP allow list Optional, rejects requests from any other address
Expiry Optional, the token stops working after a date you choose

Give each script or service its own token with the smallest scope that works. A monitoring script needs read-only. A deployment pipeline needs read/write, an allow list for its runners and an expiry you renew.

A first request

Send the token as a bearer token:

curl -H "Authorization: Bearer wk_your_token_here" \
  https://api.wolkra.com/v1/servers

The response lists the servers in the token's project. The API tokens doc covers creating a token and making your first calls step by step.

How teams use the API

  • Deployment pipelines create a server, wait for it to boot, run a deploy and update a load balancer.
  • Failover scripts move a floating IP when the active server stops answering.
  • Release safety takes a snapshot before every release and deletes old ones later.
  • Short-lived environments spin up servers for a branch or a test run and delete them when done. With hourly billing, a server that lives for two hours costs two hours. See development environments.
  • Elastic CI runners add servers when queues grow and remove them when they empty.
  • Internal dashboards read servers and graphs with a read-only token.

Console, Composer and API together

The console, Composer and the API all work on the same resources. You can draw a stack in Composer, apply it, and then manage it from scripts. Changes from any of them show up in the project's activity log, so teams can see who did what. See teams and security.

Working with any language

Because the API is plain REST with JSON, you need no special library. A shell script with curl and jq, a Python script with an HTTP client, a Go service or a Node.js job all work the same way: send a request with the bearer token, read the JSON response, check the status code. Responses describe each resource with its ID, name, labels and state, so a script can create a server, poll until it is running, then attach a volume or add it to a load balancer.

Good habits for scripts:

  • Use labels to find resources instead of hard-coding IDs.
  • Check the HTTP status code of every call and stop on errors.
  • Poll for state changes with a pause between requests rather than in a tight loop.
  • Keep separate tokens for separate jobs, so revoking one does not break the others.

Security notes

  • Treat tokens like passwords. Store them in a secret manager or your CI's secret store, never in a public repository.
  • Use the IP allow list for tokens that run from fixed addresses.
  • Set an expiry on tokens for contractors and temporary jobs.
  • Revoke a token in the console the moment you suspect it leaked.

Limits to know

  • The API is the way to automate Wolkra. Use curl or any HTTP client.
  • Each token works within one project.
  • Resources are created in Frankfurt, our only location today.

Related pages

Start automating

Create a project, generate a token and make your first call in minutes. Sign up for Wolkra.

Frequently asked questions

Where is the Wolkra API?

The REST API is at https://api.wolkra.com/v1. It uses JSON over HTTPS and is authenticated with an API token in the Authorization header.

How do API tokens work?

You create tokens in the console. Each token belongs to one project, starts with wk_, and is either read-only or read/write. You can add an IP allow list and an expiry date.

Which tools can I use with the API?

Any tool that speaks HTTPS and JSON works, from curl in a shell script to the HTTP client of your favourite programming language.

What can I do with the API?

The API covers the resources you manage in the console, such as servers, volumes, networks, firewalls, load balancers and IP addresses.

Is the API free to use?

Yes. There is no charge for API calls. You pay only for the resources you create, billed by the hour from your prepaid balance.