Sanity Library Reference Docs
    Preparing search index...

    Function defineCorsOrigin

    • Beta

      Defines a CORS Origin to be managed in a Blueprint.

      defineCorsOrigin({
        name: 'my-cors-origin',
        origin: 'https://mydomain.com',
        allowCredentials: true,
      })

      Parameters

      • parameters: BlueprintCorsOriginConfig

        The CORS Origin configuration

        Deploying CORS Origins via Blueprints is experimental. This feature is stabilizing but may still be subject to breaking changes.

        Configuration for a CORS Origin resource.

        • Optional BetaallowCredentials?: boolean

          When adding a CORS origin, you will also need to decide whether or not to allow credentials. If you allow credentials, the origin will be allowed to send authenticated requests using the token or session of a logged in user.

          If this origin hosts a studio, you will need to allow credentials. Otherwise, you should probably select not to allow credentials.

          Allowing credentials from wildcard origins is dangerous. Any domain that matches the given pattern will be able to send requests on the user's behalf if they are logged in to your studio.

          false
        • Betaname: string
        • Betaorigin: string

          A CORS origin will be defined using the following format: protocol://hostname[:port]

          The protocol and host name are required while the port is optional. Wildcards (*) are allowed.

        • Optional Betaproject?: string

          The project ID of the project that contains your CORS Origin.

          The project attribute must be defined if your blueprint is scoped to an organization.

      Returns BlueprintCorsOriginResource

      The CORS Origin resource

    Settings

    Member Visibility