How to view and manage API keys

Overview

There are two types of API Keys within Modzy - Team API Keys and Project API Keys. Each team within Modzy has a unique key, and each project within the team has it's own key as well. A user would use their team key to run jobs tied to that team, while they would use the project key to run jobs tied to that particular project.

Download Team API Key

You can find a comprehensive list of your Team API Keys in Your Profile. To navigate to your Profile, click on the top left header and select "Profile & API Keys." The landing page will show a list of your Team Keys, available for each team you are a part of. Click "Get Key" next to each team. This will download your full API key, which you will need to save to run jobs tied to that team. We will discuss how to replace this key if you lose it in the next section.

Replace Team API Key

To replace your Team API Key, you will click the red "Replace Key" button next to the key prefix. This is a permanent action, and you will need to re-download and save your team key.

Download Project API Key

Project keys allow users to run automated processes that include shared credentials, service accounts, and others. These keys allow users to execute full job lifecycles. You will see the "Key Prefix" for the project on the "All Projects" tab. The prefix is the API keys' visible part. It is unique and is only used to identify the key and by itself, is unable to perform API requests. There are two locations to download your full API key, and to do so, you must be the owner of the project.

Downloading via Projects Page

Find the "Projects" section on the top navigation. From there, find your project and select the project to see the Project Details. Click "Get Key" at the top right" of the screen. This will download your full API key, which you will need to save to run jobs. We will discuss how to replace this key if you lose it in the next section.

Downloading via Profile Page

Another way to download your Project API key is via your profile. To find your profile, navigate to the top left header and select "Profile & API Keys." Click on the second tab "Project Keys" and click "Get Key." This will download your full API key.

Replace Project API Key

To replace your Project API Key via the Projects section, you will click the red "Replace Key" button at the top right of your project's page. This is a permanent action, and you will need to re-download and save your project key.

To replace your Project API Key via Your Profile, you will click the red "Replace Key" button next to the key prefix. This is a permanent action, and you will need to re-download and save your project key.