Lightdash · Example Payload

Lightdash Organization Warehouse Credentials Example

Organization Warehouse Credentials

Lightdash Organization Warehouse Credentials Example is an example object payload from Lightdash, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

methodpathsummarytagsrequestBodyresponses

Example Payload

Raw ↑ 
{
  "method": "POST",
  "path": "/api/v1/org/warehouse-credentials",
  "summary": "Create warehouse credentials",
  "tags": [
    "Organization Warehouse Credentials"
  ],
  "requestBody": {
    "description": "the warehouse credentials to create",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CreateOrganizationWarehouseCredentials",
          "description": "the warehouse credentials to create"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Ok",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ApiOrganizationWarehouseCredentialsResponse"
          }
        }
      }
    },
    "default": {
      "description": "Error",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ApiErrorPayload"
          }
        }
      }
    }
  }
}