# API Keys

Your API requests are [authenticated](broken://pages/-MOG78wscPDYjqQ0i99W) using the account's API key. If you do not include your key when making an API request or use an incorrect one, we return an error.

## Obtaining your API keys

You have the option to solicit the creation of your API keys by sending an email to **<support@deepstone.cloud>**. If you have any inquiries or require further assistance, our dedicated support team will be more than happy to assist you in this matter. Please feel free to reach out at your convenience, and we will promptly address your request with the utmost attention to detail and efficiency.

For security reasons each API key is associated with one or more CIDRs. \
When you request the creation of the key, please indicate the IPs enabled to use it.

## Keeping your keys safe

It is strongly recommended to keep your API key safe and confidential. To help keep your API keys secure, follow these best practices:

1. **Do not embed API keys directly in code**. API keys that are embedded in code can be accidentally exposed to the public. For instance, you might overlook removing keys from shared code. Instead of embedding API keys directly into your applications, consider storing them in environment variables or files located outside your application's source tree.
2. **Do not store API keys in files inside your application's source tree**. If you store API keys in files, place them outside your application's source tree. This helps prevent your keys from being included in your source code control system. This precaution is crucial, especially when using a public source code management system like GitHub.

## Compromised keys

In the event that your API key becomes compromised, kindly reach out to us at **<support@deepstone.cloud>**, providing the key for prompt deactivation. Our dedicated service ensures the swift invalidation of the compromised key, accompanied by the seamless generation of a replacement key for your continued security and access assurance. Feel free to rely on this streamlined process as part of our commitment to safeguarding your digital interactions and maintaining the integrity of your access credentials.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://resource.deepstone.cloud/deepstone-api/api-keys.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.