Sanity Library Reference Docs
    Preparing search index...

    Interface ArchiveReleaseActionBeta

    Archives an active release. Version documents within the release are removed and no longer queryable, though still recoverable through history during the retention period.

    interface ArchiveReleaseAction {
        dataset?: string;
        perspective?: ReleasePerspective | ClientPerspective;
        projectId?: string;
        releaseId: string;
        resource?: DocumentResource;
        type: "release.archive";
    }

    Hierarchy (View Summary)

    Index

    Properties

    dataset? perspective? projectId? releaseId resource? type

    Properties

    dataset?: string
    perspective?: ReleasePerspective | ClientPerspective
    projectId?: string
    releaseId: string
    resource?: DocumentResource

    Explicit resource to use. On an individual operation this overrides any default; on a SanityConfig it becomes the instance's default resource. Unlike projectId/dataset, this can also be a media library or canvas resource.

    type: "release.archive"

    Settings

    Member Visibility

    On This Page

    Properties