@archastro/sdk
    Preparing search index...

    Interface SandboxKey

    An API key scoped to a developer sandbox, used to authenticate requests against sandbox resources.

    interface SandboxKey {
        created_at?: string;
        expires_at?: string | null;
        full_key?: string;
        id: string;
        key_hint?: string | null;
        key_value?: string | null;
        last_used_at?: string | null;
        status: string;
        type: string;
    }
    Index

    Properties

    created_at? expires_at? full_key? id key_hint? key_value? last_used_at? status type

    Properties

    created_at?: string

    When this key was created (ISO 8601).

    expires_at?: string | null

    When this key expires and becomes invalid. null if the key does not expire.

    full_key?: string

    The complete secret key value, returned only once when the key is first created. null on subsequent retrievals.

    id: string

    Sandbox key ID (dsk_...).

    key_hint?: string | null

    A short hint showing the last four characters of the key, used for identification. null if no hint is available.

    key_value?: string | null

    The full key value for "publishable" keys. null for "secret" keys; use full_key instead, which is returned only at creation time.

    last_used_at?: string | null

    When this key was last used to authenticate a request. null if the key has never been used.

    status: string

    Current lifecycle status of the key. One of "active" (usable) or "revoked" (permanently disabled).

    type: string

    The kind of key. One of "publishable" (safe for client-side use) or "secret" (server-side only).

    Settings

    Member Visibility

    On This Page

    Properties