@archastro/sdk
    Preparing search index...

    Class ExternalObjectResource

    Index

    Constructors

    constructor

    Methods

    create delete get list update

    Constructors

    Methods

    • Provision an external object through an integration service

      Parameters

      • input: {
            agent?: string;
            object:
                | {
                    location_hint?: string;
                    name: string;
                    storage_class?: string;
                    type: "r2_bucket";
                }
                | {
                    jurisdiction?: string;
                    location_hint?: string;
                    name: string;
                    type: "d1_database";
                };
            org?: string;
            service: "cloudflare";
            team?: string;
            user?: string;
        }

        Request body.

        • Optionalagent?: string

          Owning agent ID (agt_...). Supply exactly one owner field.

        • object:
              | {
                  location_hint?: string;
                  name: string;
                  storage_class?: string;
                  type: "r2_bucket";
              }
              | {
                  jurisdiction?: string;
                  location_hint?: string;
                  name: string;
                  type: "d1_database";
              }

          Provisioning fields selected by external object type.

        • Optionalorg?: string

          Owning organization ID (org_...). Supply exactly one owner field.

        • service: "cloudflare"
        • Optionalteam?: string

          Owning team ID (tem_...). Supply exactly one owner field.

        • Optionaluser?: string

          Owning user ID (usr_...). Supply exactly one owner field.

      Returns Promise<ExternalObject>

      Successful response

    • List external objects

      Parameters

      • Optionalparams: {
            page?: number;
            pageSize?: number;
            search?: string;
            service?: "cloudflare";
            type?: "d1_database" | "r2_bucket";
        }

        Query parameters.

      Returns Promise<
          {
              data: {
                  agent?: string;
                  created_at: string;
                  id: string;
                  integration: string;
                  object: | {
                      id: string;
                      location?: string;
                      name: string;
                      storage_class?: string;
                      type: "r2_bucket";
                  }
                  | {
                      id: string;
                      jurisdiction?: string;
                      name: string;
                      read_replication?: Record<string, unknown>;
                      type: "d1_database";
                  };
                  org?: string;
                  service: "cloudflare";
                  team?: string;
                  updated_at: string;
                  user?: string;
              }[];
              has_next: boolean;
              has_prev: boolean;
              page: number;
              page_size: number;
              total_entries: number;
              total_pages: number;
          },
      >

      Successful response

    • Update an external object

      Parameters

      • externalObject: string
      • input: {
            object:
                | { storage_class: string; type: "r2_bucket" }
                | { read_replication_mode: "auto" | "disabled"; type: "d1_database" };
        }

        Request body.

        • object:
              | { storage_class: string; type: "r2_bucket" }
              | { read_replication_mode: "auto" | "disabled"; type: "d1_database" }

          Mutable fields selected by external object type.

      Returns Promise<ExternalObject>

      Successful response

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods