API quickstart

The STACKIT Domain Services API is a RESTful interface that allows you to automate the management of your domains, DNS zones, and associated resources.

This guide shows you how to gain access to the testing environment, generate your authentication token, and retrieve your organization ID.

Request access to the testing environment

We recommend starting your development in the Operational Testing Environment (OTE). The OTE is a replica of the production system that does not run real, fee-based domain orders.

1. Send an email to domainservices@stackit.cloud to request access.
2. Include the subject line “API Zugang für OTE System anfordern”.
3. Provide the email addresses of all team members who require access.

Generate an access token

The API uses JSON Web Tokens (JWT) for authorization. You must exchange your credentials for an access token before you can call any protected endpoints.

1. Send a POST request to the token endpoint. For the OTE environment, use https://api.ote.domains.stackit.cloud/api/access-control/token.
2. Include your portal email address and password in the request body.

   {
     "email": "YOUR_PORTAL_EMAIL_ADDRESS",
     "password": "YOUR_PASSWORD"
   }

3. Extract the access_token from the response.

Tokens are valid for 3600 seconds (15 minutes). Once a token expires, the system returns a 401 Unauthorized error, and you must generate a new one.

Retrieve your organization ID

Almost all API endpoints require an organizationId as a path parameter. You must retrieve this ID using your access token.

1. Send a GET request to the organizations endpoint: https://publicapi.ote.domains.stackit.cloud/api/v1/organizations.
2. Add your token to the HTTP header using the Authorization: Bearer <JWT_TOKEN> format.
3. Copy the organizationId from the JSON response.

You are now ready to use this ID to automate tasks such as checking domain availability, creating DNS zones, or managing resource records.