Skip to main content
API Explorer|API Explorer
Security & Audit/Security
POSTSecuritySince 1.0SynchronousAuth Required

ConfigureSyncSource

Configure a CVE data sync source with credentials and schedule.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • configObjectRequired

    Sync source configuration to create or update

    • idString

      Unique identifier for this sync source configuration

      Example: sync-src-001

    • typeString

      Type of the CVE data sync source

      Example: SYNC_SOURCE_TYPE_UNSPECIFIED

    • apiKeyMaskedString

      API key with sensitive characters masked for display

      Example: abc***xyz

    • syncIntervalHoursInteger

      Interval in hours between automatic sync operations

      Example: 24

    • ecosystemsList

      List of package ecosystems to sync CVE data for

      Example: item1,item2

    • lastModifiedSinceString

      Timestamp filter to fetch only entries modified since this time

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

    • createdAtString

      Timestamp when this sync source was first configured

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

  • apiKeyStringRequired

    Plain-text API key for authenticating with the sync source

    Example: sk-nvd-abc123secret

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier for this sync source configuration

    Example: sync-src-001

  • typeString

    Type of the CVE data sync source

    Example: SYNC_SOURCE_TYPE_UNSPECIFIED

  • apiKeyMaskedString

    API key with sensitive characters masked for display

    Example: abc***xyz

  • syncIntervalHoursInteger

    Interval in hours between automatic sync operations

    Example: 24

  • ecosystemsList

    List of package ecosystems to sync CVE data for

    Example: item1,item2

  • lastModifiedSinceString

    Timestamp filter to fetch only entries modified since this time

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

  • createdAtString

    Timestamp when this sync source was first configured

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

Endpoint

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

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

Operation ID

ConfigureSyncSource

Permalink

Request Example

curl -X POST '{host}/api/v1/security/cve/sync-sources' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"config":{"id":"sync-src-001","type":"SYNC_SOURCE_TYPE_UNSPECIFIED","apiKeyMasked":"abc***xyz","syncIntervalHours":24,"ecosystems":"item1,item2","lastModifiedSince":"2024-01-01T00:00:00Z","createdAt":"2026-01-15T08:00:00Z"},"apiKey":"sk-nvd-abc123secret"}'

Response Example

200
{
  "id": "sync-src-001",
  "type": {},
  "apiKeyMasked": "abc***xyz",
  "syncIntervalHours": 24,
  "ecosystems": [],
  "lastModifiedSince": "2024-01-01T00:00:00Z",
  "createdAt": "example"
}

Change History

This API has no change history records yet.

View all change history