@servicenow/sdk - v4.9.0
    Preparing search index...

    Interface RetryPolicy

    Defines a retry policy for outbound integration connections.

    A retry policy specifies how many times to retry a failed connection, how long to wait between attempts, and under what conditions retries apply. Supports HTTP, JDBC, and SFTP connection types.

    The type uses a discriminated union to enforce constraints at compile-time:

    • retry_after strategy requires maxElapsedTime and HTTP connection type
    • condition field is only valid for HTTP connection types
    • count and interval are not valid with retry_after strategy
    interface RetryPolicy {
        $id: string | number | ExplicitKey<string>;
        $override?: Record<string, string | number | boolean>;
        connectionType?:
            | "http_retry_conditions"
            | "jdbc_retry_conditions"
            | "basic_retry_conditions";
        name?: string;
        protectionPolicy?: "read"
        | "protected";
        restrictTo?: string[];
        retryStrategy?:
            | "retry_after"
            | "fixed_time_interval"
            | "exponential_backoff";
    }
    Index

    Properties

    $id $override? connectionType? name? protectionPolicy? restrictTo? retryStrategy?

    Properties

    $id: string | number | ExplicitKey<string>
    $override?: Record<string, string | number | boolean>

    Set properties not directly supported by this API.

    connectionType?:
        | "http_retry_conditions"
        | "jdbc_retry_conditions"
        | "basic_retry_conditions"

    Connection type for the retry policy.

    • 'http_retry_conditions': HTTP connection type.
    name?: string

    Display name shown in the retry policy list.

    protectionPolicy?: "read" | "protected"

    Controls edit/view access for other developers after the application is installed.

    • read: Others can see the script logic but not change it.
    • protected: Others cannot change this record.
    • Omit to allow other developers to customize this record.
    restrictTo?: string[]

    Fields evaluated in the condition to determine whether to retry.

    ['http_method', 'status_code', 'error', 'response_body', 'response_headers']

    ['status_code', 'error']
    retryStrategy?: "retry_after" | "fixed_time_interval" | "exponential_backoff"

    Retry strategy to use.

    • 'retry_after': Use the Retry-After header from the response.

    Settings

    Member Visibility

    On This Page

    Properties