Official SDKs

Your infrastructure speaks your language.

Bring Vertra into the scripts and tools you already write. Official clients for JavaScript, TypeScript, Python and Go, with typed methods and access to the platform API.

Choose my SDK Read the docs

JS / TSapp.ts

const app = await client.apps.get("app-id");
await client.apps.restart(app.id);

PYapp.py

app = client.apps.get("app-id")
client.apps.restart(app["id"])

GOmain.go

app, _ := client.Apps.Get(ctx, "app-id")
_, _ = client.Apps.Restart(ctx, app.ID, nil)

JavaScript · TypeScript · Python · GoVertra API

Start with your code

Three languages. The same Vertra.

Install the package, connect your API key and make your first call. These examples use an environment variable to keep the key out of your code.

JavaScript / TypeScript

npm

Async methods and types for autocomplete as you develop in JavaScript and TypeScript.

app.ts

import { VertraClient } from "@vertracloud/sdk-api";

const client = new VertraClient({
  apiKey: process.env.VERTRA_API_KEY!,
});

const app = await client.apps.get("app-id");
console.log(app.name);

Python

PyPI

A synchronous, typed client for your Python scripts, bots and tools.

app.py

import os
from vertracloud import VertraClient

client = VertraClient(
    api_key=os.environ["VERTRA_API_KEY"]
)

app = client.apps.get("app-id")
print(app["name"])

Go

pkg.go.dev

An idiomatic client with context.Context for Go services, CLIs and automation.

main.go

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/vertracloud/sdk-api-go/rest"
	"github.com/vertracloud/sdk-api-go/vertracloud"
)

func main() {
	restClient, err := rest.NewClient(os.Getenv("VERTRA_API_KEY"))
	if err != nil {
		log.Fatal(err)
	}
	client := vertracloud.New(restClient)

	app, err := client.Apps.Get(context.Background(), "app-id")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(app.Name)
}

In your workflow

Less manual HTTP. More of your project.

Use public API resources through methods you can discover in your editor.

Applications and databases

Check status and metrics, start, stop and restart resources from your code.

Files and snapshots

Read and update files, configure environment variables, and create or restore snapshots.

Errors you can handle

Identify authentication, permissions and request limits with dedicated error classes.

Workspaces and automation

Connect projects, members and roles to your processes. Every call respects your key’s scopes.

Your first integration

From installation to the first response.

Install the package

Use npm, pip or go get in your project environment, depending on the language.

Create your key

Create an API key in the dashboard with the permissions you need, then set VERTRA_API_KEY in your script environment.

Connect your resources

Provide the application ID and retrieve its data. Then combine the calls your automation needs.

FAQ

Before your first call.

Can I use the JavaScript SDK in a browser?

Use the SDK in a server environment. An API key in a browser is exposed to visitors; keep authenticated calls in your backend.

Do the SDKs expose the whole dashboard?

They cover public API resources allowed by your key’s scopes. Key management, invitations and browsing database contents remain in the dashboard.

How do I monitor my application?

Use apps methods to retrieve status, metrics and logs. The realtime method also lets you consume live events.

Do API limits still apply?

Yes. Calls follow your account’s API permissions and limits. Handle rate limit errors in your integration.