Class default

Typed SDK for game website hosting, managed database add-ons, domains, usage, deployment instructions, and hosted-play attribution.

Constructors

constructor

Methods

activateAwsMarketplaceSubscription activateMarketplaceSubscription aiInstructions applyServices awsMarketplaceSubscription billingCheckout catalog channelAnalytics checkDomain confirmBillingCheckout connectDomain createDatabase createRelease createSite createUploadUrl dashboard database databaseCredentials databases deleteDatabase deleteServiceSecret estimateServices heartbeatPlaySession marketplaceSubscription promoteRelease purchaseDomain putServiceSecret releases resolve resolveAwsMarketplacePurchase resolveMarketplacePurchase retryDatabase services startPlaySession updateDatabase updateSite uploadBuild verifyDomain

Constructors

constructor

Methods

Static activateAwsMarketplaceSubscription

  • activateAwsMarketplaceSubscription<T>(subscription_id, community_id): AxiosPromise<default<T>>

  • Connect a paid AWS Marketplace contract to one Glitch business account.

    Type Parameters

    • T

    Parameters

    • subscription_id: string
    • community_id: string

    Returns AxiosPromise<default<T>>

Static activateMarketplaceSubscription

  • activateMarketplaceSubscription<T>(subscription_id, community_id): AxiosPromise<default<T>>

  • Link a resolved Microsoft Marketplace subscription to a billable Glitch business account.

    Type Parameters

    • T

    Parameters

    • subscription_id: string
    • community_id: string

    Returns AxiosPromise<default<T>>

Static aiInstructions

Static applyServices

Static awsMarketplaceSubscription

  • awsMarketplaceSubscription<T>(subscription_id): AxiosPromise<default<T>>

  • Refresh and retrieve the safe AWS Marketplace entitlement state.

    Type Parameters

    • T

    Parameters

    • subscription_id: string

    Returns AxiosPromise<default<T>>

Static billingCheckout

  • billingCheckout<T>(title_id, plan): AxiosPromise<default<T>>

  • Start or apply a bandwidth-based Hosting plan, separate from Store distribution.

    Type Parameters

    • T

    Parameters

    Returns AxiosPromise<default<T>>

Static catalog

Static channelAnalytics

  • channelAnalytics<T>(title_id, params?): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static checkDomain

Static confirmBillingCheckout

  • confirmBillingCheckout<T>(title_id, checkout_session_id): AxiosPromise<default<T>>

  • Confirm a paid Stripe Checkout session before provisioning its add-on.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • checkout_session_id: string

    Returns AxiosPromise<default<T>>

Static connectDomain

  • connectDomain<T>(title_id, site_id, hostname): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • hostname: string

    Returns AxiosPromise<default<T>>

Static createDatabase

Static createRelease

Static createSite

Static createUploadUrl

  • createUploadUrl<T>(title_id, site_id): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string

    Returns AxiosPromise<default<T>>

Static dashboard

Static database

  • database<T>(title_id, site_id, database_id): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • database_id: string

    Returns AxiosPromise<default<T>>

Static databaseCredentials

  • databaseCredentials<T>(title_id, site_id, database_id, confirmation): AxiosPromise<default<T>>

  • Reveal credentials to a signed-in business billing administrator after an exact database-name confirmation. Hosting and MCP tokens are rejected.

    Type Parameters

    Parameters

    • title_id: string
    • site_id: string
    • database_id: string
    • confirmation: string

    Returns AxiosPromise<default<T>>

Static databases

  • databases<T>(title_id, site_id, params?): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static deleteDatabase

  • deleteDatabase<T>(title_id, site_id, database_id, confirmation): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • database_id: string
    • confirmation: string

    Returns AxiosPromise<default<T>>

Static deleteServiceSecret

  • deleteServiceSecret<T>(title_id, site_id, service_id, name): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • service_id: string
    • name: string

    Returns AxiosPromise<default<T>>

Static estimateServices

Static heartbeatPlaySession

  • heartbeatPlaySession<T>(session_id, sessionToken): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • session_id: string
    • sessionToken: string

    Returns AxiosPromise<default<T>>

Static marketplaceSubscription

  • marketplaceSubscription<T>(subscription_id): AxiosPromise<default<T>>

  • Retrieve safe Microsoft Marketplace entitlement and lifecycle status.

    Type Parameters

    • T

    Parameters

    • subscription_id: string

    Returns AxiosPromise<default<T>>

Static promoteRelease

  • promoteRelease<T>(title_id, site_id, release_id): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • release_id: string

    Returns AxiosPromise<default<T>>

Static purchaseDomain

  • purchaseDomain<T>(title_id, site_id, data): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • data: Record<string, any>

    Returns AxiosPromise<default<T>>

Static putServiceSecret

  • putServiceSecret<T>(title_id, site_id, service_id, name, value): AxiosPromise<default<T>>

  • Store or rotate a secret. The API never returns the value. Interactive administrators only.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • service_id: string
    • name: string
    • value: string

    Returns AxiosPromise<default<T>>

Static releases

  • releases<T>(title_id, site_id, params?): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static resolve

  • resolve<T>(hostname, gatewayToken?): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • hostname: string
    • Optional gatewayToken: string

    Returns AxiosPromise<default<T>>

Static resolveAwsMarketplacePurchase

  • resolveAwsMarketplacePurchase<T>(activation_code): AxiosPromise<default<T>>

  • Claim the one-time Glitch code created after AWS ResolveCustomer succeeds.

    Type Parameters

    • T

    Parameters

    • activation_code: string

    Returns AxiosPromise<default<T>>

Static resolveMarketplacePurchase

  • resolveMarketplacePurchase<T>(token): AxiosPromise<default<T>>

  • Resolve the one-hour purchase token passed to Glitch by Microsoft Marketplace.

    Type Parameters

    • T

    Parameters

    • token: string

    Returns AxiosPromise<default<T>>

Static retryDatabase

Static services

Static startPlaySession

Static updateDatabase

  • updateDatabase<T>(title_id, site_id, database_id, data): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • database_id: string
    • data: Record<string, any>

    Returns AxiosPromise<default<T>>

Static updateSite

Static uploadBuild

  • uploadBuild(uploadUrl, file, requiredHeaders?, onUploadProgress?): AxiosPromise<void>

  • Upload directly to the short-lived signed URL returned by createUploadUrl.

    Parameters

    • uploadUrl: string
    • file: Blob
    • requiredHeaders: Record<string, string> = {}
    • Optional onUploadProgress: ((event) => void)
        • (event): void

        • Parameters

          • event: AxiosProgressEvent

          Returns void

    Returns AxiosPromise<void>

Static verifyDomain

  • verifyDomain<T>(title_id, site_id, domain_id): AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • site_id: string
    • domain_id: string

    Returns AxiosPromise<default<T>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc