Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Managing API Keys-Update #822

Merged
merged 2 commits into from
Nov 27, 2024
Merged

Managing API Keys-Update #822

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9d1c44
Updating copy
idalithb Nov 22, 2024
e765cfc
Update website/pages/en/querying/managing-api-keys.mdx
idalithb Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions website/pages/en/querying/managing-api-keys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,33 @@
title: Managing your API keys
---

Regardless of whether you’re a dapp developer or a subgraph developer, you’ll need to manage your API keys. This is important for you to be able to query subgraphs because API keys make sure the connections between application services are valid and authorized. This includes authenticating the end user and the device using the application.
## Overview

The "API keys" table lists out existing API keys, which will give you the ability to manage or delete them. For each key, you can see its status, the cost for the current period, the spending limit for the current period, as well as total query numbers. You can click the "three dots" menu to edit a given API key:
API keys are needed to query subgraphs. They ensure that the connections between application services are valid and authorized, including authenticating the end user and the device using the application.

### Create and Manage API Keys

Go to [Subgraph Studio](https://thegraph.com/studio/) and click the **API Keys** tab to create and manage your API keys for specific subgraphs.

The "API keys" table lists existing API keys and allows you to manage or delete them. For each key, you can see its status, the cost for the current period, the spending limit for the current period, and the total number of queries.

You can click the "three dots" menu to the right of a given API key to:

- Rename API key
- Regenerate API key
- Delete API key
- Manage spending limit: this is an optional monthly spending limit for a given API key, in USD. This limit is per billing period (calendar month).

### API Key Details

You can click on an individual API key to view the Details page:

1. The **Overview** section will allow you to:
1. Under the **Overview** section, you can:
- Edit your key name
- Regenerate API keys
- View the current usage of the API key with stats:
- Number of queries
- Amount of GRT spent
2. Under **Security**, you’ll be able to opt into security settings depending on the level of control you’d like to have over your API keys. In this section, you can:
2. Under the **Security** section, you can opt into security settings depending on the level of control you’d like to have. Specifically, you can:
- View and manage the domain names authorized to use your API key
- Assign subgraphs that can be queried with your API key