Get Provider Dashboard

Providers Dashboard

This endpoint allows an authenticated provider to retrieve their complete account details along with a full list of all instances they have listed on marketplace. It serves as a comprehensive "dashboard" of the provider's status & offerings.

Endpoint

GET /api/v1/provider/me

Authentication

Type	Required	Location	Description
Provider Key	`true`	Header	The key must be sent as `x-api-key: PROVIDER_KEY`.

📘
This endpoint is for providers only. You must provide your unique Provider API Key to authenticate the request, and Get complete real time Data. Using an Admin Key or Super Admin Key on this endpoint will not work.

Request

This endpoint does not require a request body or any URL parameters.

Example Request

Here is an example of how to call this endpoint using cURL. Replace YOUR_PROVIDER_API_KEY with your actual key.

curl -X GET 'https://offers.dataoorts.com/api/v1/provider/me' \
-H 'x-api-key: YOUR_PROVIDER_API_KEY'

Responses

✅ Success Response (200 OK)

A successful request will return an HTTP 200 OK status code and a JSON object containing the provider's details and their instances.

Body

The response is a single JSON object with two top-level keys: provider_details and instances.

{
  "provider_details": {
    "_id": "PRO_15052024120000123",
    "name": "Quantum GPU Providers",
    "email": "[email protected]",
    "phone": "+1-555-123-4467",
    "instance_limit": 20,
    "retention_month": 12,
    "is_active": true,
    "registered_at": "2024-05-15T12:00:00.123Z"
  },
  "instances": [
    {
      "_id": "IID_21052024103005123",
      "pro_id": "PRO_15052024120000123",
      "gpu_model": "NVIDIA A100 80GB",
      "is_featured": true,
      "total_gpus": "8",
      "location": "Mumbai, India",
      "instance_type": "Bare Metal",
      "created_at_ist": "2024-05-21T10:30:05.123Z",
      "pricing": {
        "1m": {
          "original": 5000.00,
          "offered": 4899.99
        },
        "3m": {
          "original": 14500.00,
          "offered": 13999.50
        }
      }
    },
    {
      "_id": "IID_22052024114510456",
      "pro_id": "PRO_15052024120000123",
      "gpu_model": "NVIDIA H100 80GB",
      "is_featured": false,
      "total_gpus": "4",
      "location": "Singapore",
      "instance_type": "VM",
      "created_at_ist": "2024-05-22T11:45:10.456Z",
      "pricing": {
        "1w": {
          "original": 750.00,
          "offered": 699.00
        }
      }
    }
  ]
}

provider_details Field Descriptions:

Field	Type	Description
`_id`	string	The provider's unique ID.
`name`	string	The provider's registered name.
`email`	string	The provider's contact email.
`phone`	string	The provider's contact phone number.
`instance_limit`	integer	The maximum number of instances this provider can list.
`retention_month`	integer	The number of months instances are kept before auto-deletion.
`is_active`	boolean	The status of the provider's account.
`registered_at`	string	The ISO 8601 timestamp of when the provider registered.

instances Array Object Field Descriptions:

This is a partial list of fields for brevity. The objects in this array contain the full instance details as defined in the Create an Instance endpoint.

❌ Error Response (401 Unauthorized)

Returned if the x-api-key header is missing or the provided key is invalid.

Body

{
  "error": "Unauthorized: Invalid API key."
}

❗️
More than three failed authentication attempts will result in a permanent IP block.

❌ Error Response (500 Internal Server Error)

Returned for database errors or other unexpected issues on the server.

Body (Example: Authentication DB Error)

{
  "error": "Database error during authentication.",
  "details": "Specific error message from the database driver."
}

Body (Example: Instance Fetching DB Error)

{
  "error": "Database error while fetching instances.",
  "details": "Specific error message from the database driver."
}