Skip to main content

SystemIntegrationsListResponse

Response containing a list of system integrations

integrations object[]required

List of system integrations

  • Array [
  • configrequired

    Non-sensitive configuration

    createdAtstring<date-time>required

    When the integration was created

    displayNamestringrequired

    Human-readable display name

    Example: MangaUpdates
    enabledbooleanrequired

    Whether the integration is enabled

    Example: true
    errorMessagestring | nullnullable

    Error message if health check failed

    hasCredentialsbooleanrequired

    Whether credentials have been set (actual credentials are never returned)

    Example: true
    healthStatusstringrequired

    Health status: unknown, healthy, degraded, unhealthy, disabled

    Example: healthy
    idstring<uuid>required

    Integration ID

    Example: 550e8400-e29b-41d4-a716-446655440000
    integrationTypestringrequired

    Integration type: metadata_provider, notification, storage, sync

    Example: metadata_provider
    lastHealthCheckAtstring,null<date-time>nullable

    When the last health check was performed

    Example: 2024-01-15T18:45:00Z
    lastSyncAtstring,null<date-time>nullable

    When the integration last synced data

    Example: 2024-01-15T18:00:00Z
    namestringrequired

    Unique integration name (e.g., "mangaupdates", "anilist")

    Example: mangaupdates
    updatedAtstring<date-time>required

    When the integration was last updated

  • ]
  • totalintegerrequired

    Total count

    Possible values: >= 0

    SystemIntegrationsListResponse
    {
    "integrations": [
    {
    "createdAt": "2024-07-29T15:51:28.071Z",
    "displayName": "MangaUpdates",
    "enabled": true,
    "errorMessage": "string",
    "hasCredentials": true,
    "healthStatus": "healthy",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "integrationType": "metadata_provider",
    "lastHealthCheckAt": "2024-01-15T18:45:00Z",
    "lastSyncAt": "2024-01-15T18:00:00Z",
    "name": "mangaupdates",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "total": 0
    }