Generate API Key

To work with the Renta REST API, you will need an API key (token). It is used to authenticate your requests and defines the access level to your workspace resources.

The API key is tied to your workspace and user. Make sure you have selected the correct workspace before creating a key.

How to generate an API key

Follow these steps to create a new API key in the Renta interface.

Go to API key settingsStep 1

Click on your profile icon or workspace name in the bottom left corner of the screen. In the menu that appears, select API keys. Then, on the page that opens, click the Create API key button.

Configure key parametersStep 2

Enter a descriptive name for your token in the Token name field, for example, Airflow - Production.

In the Scopes section, select the required access rights. You can restrict access to read-only or allow a full cycle of operations (Create, Update, Delete) for various resources such as Source or Destination.

Once configuration is complete, click the Create API key button.

Save your API keyStep 3

Your API key has been successfully created!

Be sure to copy and save your API key now. For security reasons, you will not be able to see it again after closing this window.

Use the copy buttons next to the API key, Workspace ID, and User ID fields to save the necessary data. After that, you can close the window by clicking the Close button.

Available scopes

When creating an API key, you can select the following permissions for various resources:

Resource	Scope	Description
Source	Read	Read data sources
	Create	Create data sources
	Update	Update data sources
	Delete	Delete data sources
	All	All permissions for data sources
Destination	Read	Read destinations
	Create	Create destinations
	Update	Update destinations
	Delete	Delete destinations
	All	All permissions for destinations
Pipeline	Read	Read pipelines
	Create	Create pipelines
	Update	Update pipelines
	Delete	Delete pipelines
	All	All permissions for pipelines
Tracking Plan	Read	Read tracking plans
	Create	Create tracking plans
	Update	Update tracking plans
	Delete	Delete tracking plans
	All	All permissions for tracking plans
Tracking Plan Event	Read	Read events
	Create	Create events
	Update	Update events
	Delete	Delete events
	All	All permissions for events
Tracking Plan Property	Read	Read properties
	Create	Create properties
	Update	Update properties
	Delete	Delete properties
	All	All permissions for properties

Ready to get started?

Build your data pipeline today or get a personalized demo. Start free!

Need help?

Get expert support to ensure your project succeeds. We're here to help!

Feature requests?

Help shape our product! Share your ideas for new features and integrations.