Function get

  • get(
        endpoint_uuid: string,
        options?: { payload?: undefined; query?: undefined } & {
            headers?: Headers;
            query?: {
                [key: string]:
                    | undefined
                    | null
                    | string
                    | number
                    | boolean
                    | (undefined | null | string | number)[];
            };
        },
        sdkOptions?: SDKOptions,
    ): Promise<
        JSONFetchResponse<
            {
                config?: Record<string, unknown>;
                description?: string;
                display_name: string;
                endpoint_version?: string;
                hostname?: string;
                ip_address?: string;
                local_user?: string;
                multi_user: boolean;
                name: string;
                public: boolean;
                sdk_version?: string;
                subscription_uuid?: string;
                user_config_schema?: Record<string, unknown>;
                user_config_template?: string;
                uuid: string;
            },
        >,
    >

  • Parameters

    • endpoint_uuid: string
    • Optionaloptions: { payload?: undefined; query?: undefined } & {
          headers?: Headers;
          query?: {
              [key: string]:
                  | undefined
                  | null
                  | string
                  | number
                  | boolean
                  | (undefined | null | string | number)[];
          };
      }
    • OptionalsdkOptions: SDKOptions

    Returns Promise<
        JSONFetchResponse<
            {
                config?: Record<string, unknown>;
                description?: string;
                display_name: string;
                endpoint_version?: string;
                hostname?: string;
                ip_address?: string;
                local_user?: string;
                multi_user: boolean;
                name: string;
                public: boolean;
                sdk_version?: string;
                subscription_uuid?: string;
                user_config_schema?: Record<string, unknown>;
                user_config_template?: string;
                uuid: string;
            },
        >,
    >

Settings

Member Visibility