Tenant API

API

The "Tenant API" refers to an API (Application Programming Interface) designed to manage and interact with the resources of a single Tenant.

Create API Tokens

Steps to Create API-Tokens

  1. Access Administration:

    • Navigate to the cockpit menu, go to "Administration," and select "Tenant."

  2. Open API Section:

    • Click on "API" to open the menu, then click the "Create" icon on the right side of the screen.

  3. Fill in Required Information:

    • Name: Enter a required name for the API token.

    • Description: Add a description to facilitate the organization of the Tenant.

    • Expiration Date (optional): Set an expiration date if needed.

    • Tenant: Select the specific Tenant to receive the API call, or choose "All Tenants."

    • Permissions: Select or deselect permissions such as Read, Write, Create, Delete.

  4. Generate and Save API Token:

    • Click "Next" to generate the API token. The token will be displayed and can be copied.

  5. Click "Save" to complete the process.

Last updated

Was this helpful?