Qyra
ReferenceProjects

Deposit connection

Deposits durable warehouse credentials against a connect code. Called by the Qyra CLI; the connect code is the bearer credential, so this endpoint is intentionally unauthenticated

POST/api/v1/warehouse-connect/deposit

Deposits durable warehouse credentials against a connect code. Called by the Qyra CLI; the connect code is the bearer credential, so this endpoint is intentionally unauthenticated

Authentication: personal access token. The spec defines an api_key security scheme — send an Authorization: ApiKey <your-personal-access-token> header (value format: ApiKey <your key>). A session_cookie scheme (connect.sid) exists for browser sessions. Operations in this spec declare security: [], an artifact of the upstream spec generator — authentication is still enforced by the server.

Request body

{
  "inventory": {
    "schemas": [
      {
        "name": "string",
        "database": "string"
      }
    ],
    "roles": [
      {
        "isDefault": true,
        "name": "string"
      }
    ],
    "warehouses": [
      {
        "state": "string",
        "size": "string",
        "name": "string"
      }
    ],
    "databases": [
      {
        "sizeBytes": 0,
        "comment": "string",
        "name": "string"
      }
    ]
  },
  "credentials": {
    "type": "snowflake",
    "user": "string",
    "password": "string",
    "privateKey": "string",
    "privateKeyPass": "string",
    "token": "string",
    "refreshToken": "string",
    "account": "string",
    "requireUserCredentials": true,
    "authenticationType": "password",
    "role": "string",
    "threads": 0,
    "clientSessionKeepAlive": true,
    "queryTag": "string",
    "accessUrl": "string",
    "startOfWeek": {},
    "dataTimezone": "string",
    "quotedIdentifiersIgnoreCase": true,
    "disableTimestampConversion": true,
    "timeoutSeconds": 0,
    "override": true,
    "organizationWarehouseCredentialsUuid": "string",
    "database": "string",
    "warehouse": "string",
    "schema": "string"
  },
  "code": "string"
}

Responses

200 — Success

{
  "results": "string",
  "status": "ok"
}

default — Error

{
  "error": {
    "data": "string",
    "message": "string",
    "name": "string",
    "statusCode": 0
  },
  "status": "error"
}