Skip to main content
ZStack
Security & Audit/Security

ConfigureSyncSource

Configure a CVE data sync source with credentials and schedule.

POST/api/v1/security/cve/sync-sources

Operation ID

ConfigureSyncSource

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • config
    ObjectRequired

    Sync source configuration to create or update

    • id
      String

      Unique identifier for this sync source configuration

      Example: sync-src-001

    • type
      String

      Type of the CVE data sync source

      Example: SYNC_SOURCE_TYPE_UNSPECIFIED

    • apiKeyMasked
      String

      API key with sensitive characters masked for display

      Example: abc***xyz

    • syncIntervalHours
      Integer

      Interval in hours between automatic sync operations

      Example: 24

    • ecosystems
      List

      List of package ecosystems to sync CVE data for

      Example: item1,item2

    • lastModifiedSince
      String

      Timestamp filter to fetch only entries modified since this time

      Example: 2024-01-01T00:00:00Z

    • createdAt
      String

      Timestamp when this sync source was first configured

      Example: 2026-01-15T08:00:00Z

  • apiKey
    StringRequired

    Plain-text API key for authenticating with the sync source

    Example: sk-nvd-abc123secret

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • id
    String

    Unique identifier for this sync source configuration

    Example: sync-src-001

  • type
    String

    Type of the CVE data sync source

    Example: SYNC_SOURCE_TYPE_UNSPECIFIED

  • apiKeyMasked
    String

    API key with sensitive characters masked for display

    Example: abc***xyz

  • syncIntervalHours
    Integer

    Interval in hours between automatic sync operations

    Example: 24

  • ecosystems
    List

    List of package ecosystems to sync CVE data for

    Example: item1,item2

  • lastModifiedSince
    String

    Timestamp filter to fetch only entries modified since this time

    Example: 2024-01-01T00:00:00Z

  • createdAt
    String

    Timestamp when this sync source was first configured

    Example: 2026-01-15T08:00:00Z