My Zillow API Key leaked! What should I do?

What is a Zillow API Key and how it is used?

The Zillow API Key is a unique identifier that allows developers to access Zillow's real estate data and services through their API. It is used to authenticate and authorize API requests from applications.

When using the Zillow API Key, developers typically use it for the following main use cases:

Accessing Zillow's real estate data: Developers use the API key to retrieve information such as property details, home values, rental estimates, and market trends from Zillow's database.
Integrating Zillow services into applications: The API key allows developers to integrate Zillow's services, such as property search, mortgage calculators, and neighborhood information, into their own applications or websites.
Automating real estate processes: Developers can use the Zillow API key to automate tasks such as property listing updates, market analysis, and property valuation, saving time and improving efficiency.

1. Code snippets to prevent Zillow API Key hardcoding using environment variables

Using environment variables for storing sensitive information such as API keys, like the Zillow API Key, is a secure practice for several reasons:

Environment variables are not hard-coded in the code, making it difficult for attackers to access them directly.
Environment variables are stored outside of the codebase, minimizing the risk of accidental exposure through version control systems or code sharing.
Environment variables can be managed and controlled separately from the code, allowing for easier rotation and updating of sensitive information without modifying the code itself.
Access to environment variables can be restricted based on user permissions, adding an extra layer of security.

How to secure your secrets using environment variables

2. Code snippet to prevent Zillow API Key hardcoding using AWS Secrets Manager

Using AWS Secrets Manager to manage Zillow API Keys is a secure way to handle sensitive data. Here are code snippets in five different programming languages that demonstrate how to retrieve the Zillow API Key from AWS Secrets Manager.

3. Code snippet to prevent Zillow API Key hardcoding using HashiCorp Vault

Using HashiCorp Vault for managing Zillow API Keys is a great way to enhance security. Here are code snippets in five different programming languages for securely handling a Zillow API Key using HashiCorp Vault.

Remember to replace the VAULT_ADDR and VAULT_TOKEN with your Vault server address and authentication token. The snippets assume that the Zillow API Key is stored under the api_key field within Vault. The specifics of the Vault path and field names should be adjusted to match your Vault setup.

4. Code snippet to prevent Zillow API Key hardcoding using CyberArk Conjur

Using CyberArk Conjur to manage Zillow API Key is a secure way to handle sensitive data. Here are code snippets in five different programming languages that demonstrate how to retrieve the Zillow API Key from CyberArk Conjur.

How to generate a Zillow API Key?

To generate a Zillow API Key, developers need to follow these steps:

Go to the Zillow Developer website
Sign up for a Zillow Developer account
Create a new application
Obtain the API Key associated with the newly created application

Once the API Key is generated, developers can use it to access Zillow's API services for integrating real estate data into their applications.

My Zillow API Key leaked, what are the possible reasons?

There are several reasons why a Zillow API Key might have been leaked:

Improper storage: If the API Key is stored in plain text in a code repository or configuration file, it can easily be leaked if the repository or file is made public.
Hardcoding: Hardcoding the API Key directly into the code makes it vulnerable to being exposed if the code is shared or decompiled.
Logging: If the API Key is inadvertently logged in error messages or debug logs, it can be exposed to anyone with access to those logs.
Third-party services: If the API Key is used in conjunction with third-party services that have weak security measures, it can be leaked through those services.

What are the risks of leaking a Zillow API Key

When developers leak a Zillow API Key, they expose themselves to several risks:

Data Breach: Exposing the Zillow API Key can lead to unauthorized access to sensitive data, potentially compromising user information or business data.
Financial Loss: Malicious actors can exploit the leaked API Key to make unauthorized requests, leading to unexpected charges or financial losses.
Reputation Damage: A data breach or misuse of the API Key can tarnish the developer's reputation and erode trust with users or clients.
Legal Consequences: Depending on the circumstances, leaking a Zillow API Key may violate legal regulations such as data protection laws, leading to legal actions or penalties.

It is crucial for developers to understand the importance of securely managing and protecting API Keys to prevent these risks and safeguard their applications and users' data.

Zillow API Key security best practices

Avoid embedding the secret directly in your code. Instead, use environment variables or secrets managers‍
Secure storage: store the Zillow API Key in a secure location, such as a password manager or a secrets management service.
Regular rotation: periodically rotate the API key to minimize the risk of long-term exposure.
Restrict permissions: apply the principle of least privilege by only granting the key the minimum necessary permissions.
Monitor usage: regularly check the usage logs for any unusual activity or unauthorized access attempts.
Implement access controls: limit the number of users who have access to the secret and enforce strong authentication measures.
Use a secrets manager: utilize secret management tools like CyberArk or AWS Secrets Manager for enhanced security.

By adhering to the best practices, you can significantly reduce the risk associated with Zillow API Key usage and improve the overall security of your Zillow API Key implementations.

Exposing secrets on GitHub: What to do after leaking Credential and API keys

Zillow API Key leak remediation: what to do

What to do if you expose a secret: How to stay calm and respond to an incident [cheat sheet included]

How to check if Zillow API Key was used by malicious actors

Review Access Logs: Check the access logs of your Zillow API Key account for any unauthorized access or unusual activity. Pay particular attention to access from unfamiliar IP addresses (if you haven’t set up a specific allow list) or at odd hours.
Monitor Usage Patterns: Look for anomalies in the usage patterns, such as unexpected spikes in data access or transfer.
Check Active Connections and Operations: Review the list of active connections and recent operations on your database. Unusual or unauthorized operations might indicate malicious use.
Audit API Usage: If possible, audit the usage of your API key through any logging or monitoring services you have integrated with Zillow API Key. This can give insights into any unauthorized use of your key.

Steps to revoke the Zillow API Key

Generate a new Zillow API Key:

Log into your Zillow API Key account.
Navigate to the API section and generate a new API key.

Update Services with the new key:

Replace the compromised key with the new key in all your services that use this API key.
Ensure all your applications and services are updated with the new key before deactivating the old one.

Deactivate the old Zillow API Key:

Once the new key is in place and everything is functioning correctly, deactivate the old API key.
This can typically be done from the same section where you generated the new key.

Monitor after key rotation:

After deactivating the old key, monitor your systems closely to ensure that all services are running smoothly and that there are no unauthorized access attempts.

How to understand which services will stop working

Inventory of services: keep an inventory of all services and applications that utilize your Zillow API Key.
Communication and documentation: Ensure that your team is aware of which services are dependent on the key. Maintain documentation for quick reference.
Testing: before deactivating the old key, test your services with the new key in a staging environment. This helps in identifying any services that might face issues post rotation.
Fallback strategies: Have a fallback or emergency plan in case a critical service fails after the key rotation. This might include temporary measures or quick rollback procedures.

In summary, the remediation process involves identifying potential misuse, carefully rotating the key, and ensuring minimal disruption to services. Being proactive and having a well-documented process can greatly reduce the risks associated with a compromised API key.

What about other secrets?

GitGuardian helps developers keep 350+ types of secrets out of source code. GitGuardian’s automated secrets detection and remediation solution secure every step of the development lifecycle, from code to cloud:

On developer workstations with git hooks (pre-commit and pre-push);
On code sharing platforms like GitHub, GitLab, and Bitbucket;
In CI environments (Circle CI, Travis CI, Jenkins CI, GitHub Actions, and many more);
In Docker images.

payment_intent

nullable object

The PaymentIntent object for errors returned on a request involving a PaymentIntent.

Show

child attributes

CLIENT LIBRARIES

$ gem install stripe

STRIPE-RUBY

$ pip install stripe

STRIPE-PYTHON

$ composer require stripe/stripe-php

STRIPE-PHP

MAVEN
<dependency>
  <groupId>com.stripe</groupId>
  <artifactId>stripe-java</artifactId>
  <version>24.16.0</version>
</dependency>

GRADLE
compile "com.stripe:stripe-java:24.16.0"

STRIPE-NODE

$ npm install --save stripe

STRIPE-NODE

$ go get github.com/stripe/stripe-go/v76

STRIPE-NODE

$ nuget install Stripe.net

STRIPE-NODE

SHOW

This is placeholder code

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents