Check that a partner's own database still works

Runs the same check as setPartnerDataDatabase against the database already saved: a schema is made in it, a table created, a row written and read back, and the schema removed again. Use it after changing the role’s password or the project’s settings in Neon, or when saving is failing with 503 PARTNER_DATABASE_UNAVAILABLE.

The result is recorded either way. A pass refreshes verifiedAt and clears lastVerificationError; a failure answers 422 PARTNER_DATABASE_UNVERIFIED and is recorded in lastVerificationError and lastVerificationFailedAt, so the database shows what went wrong the next time it is read. A failed check does not remove the database. details.reason is one of the reasons setPartnerDataDatabase lists, or STORED_STRING_UNREADABLE when the connection string Widgetic stored can no longer be read: set the database again, with its connection string.

This needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.

POST /partners/{partnerId}/data-database/verify

TypeScript SDK

TypeScript

import { Configuration, PartnersApi } from '@widgetic/api-sdk-ts';

const partnersApi = new PartnersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

const { data: database } = await partnersApi.verifyPartnerDataDatabase({ partnerId });
console.log(database.verifiedAt);

200

{
  "success": true,
  "data": {
    "partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "host": "ep-cool-name-123456.eu-central-1.aws.neon.tech",
    "databaseName": "neondb",
    "roleName": "widgetic_data",
    "verifiedAt": "2026-01-15T09:30:00.000Z",
    "lastVerificationError": "Example lastVerificationError",
    "lastVerificationFailedAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partnerId · string<uuid> · required

The partner whose database to check

Response

200

application/json

The database passed the check

success · boolean · required

Always true on a success.

Example:

true

data · object · required

The Neon database your compositions keep what visitors leave in them (votes, ratings, answers, form submissions). The connection string and its password are never part of this: they are given once, when the database is set.

Show child attributes

Example:

{
  "partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "host": "ep-cool-name-123456.eu-central-1.aws.neon.tech",
  "databaseName": "neondb",
  "roleName": "widgetic_data",
  "verifiedAt": "2026-01-15T09:30:00.000Z",
  "lastVerificationError": "Example lastVerificationError",
  "lastVerificationFailedAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z"
}

meta · object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.

Show child attributes