Endpoint Path

https://api.domainscraper.online/keys/

Introduction

The /keys/ endpoint allows customers to manage their API keys, which can be used as an alternative authentication method for accessing the Domain Scraper API. Customers can create, list, and delete API keys and configure their permissions (read, write, or readwrite) to control access levels.

API Keys Details

1. Retrieve API Keys

• Method: GET
• Description: Fetches a list of all API keys associated with the authenticated customer, including their permissions, creation date, and last usage.

Headers

• Authorization: Bearer <your_jwt_token> or X-Key: <your_api_key>

Response

• Status Code 200 (OK):

  [
    {
      "api_key": "abcd1234-5678-90ef-ghij-klmnopqrstuv",
      "privileges": "readwrite",
      "created_at": "2024-12-01 12:00:00",
      "last_used": "2024-12-25 15:30:00"
    }
  ]
  

• Status Code 401 (Unauthorized):

  {
    "error": "Unauthorized"
  }
  

2. Create a New API Key

• Method: POST
• Description: Generates a new API key with the specified privileges for the authenticated customer.

Headers

• Authorization: Bearer <your_jwt_token> or X-Key: <your_api_key>

Body