> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# admin_offline

### admin\_offline

<ul>
  <li>
    admin\_offline(\
    &#x20;offline: boolean,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[AdminOfflineResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminOfflineResponse.md)>

    Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.

    #### Parameters

    <ul>
      <li>
        offline: boolean

        Set to true if desired state is offline.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AdminOfflineResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminOfflineResponse.md)>

    Promise\<Types.AdminOfflineResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:2359](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L2359)</li>
    </ul>
  </li>
</ul>

### admin\_offline\_request

<ul>
  <li>
    admin\_offline\_request(\
    &#x20;request: [AdminOfflineRequest](https://docs.kinetica.com/content/api/typescript/interfaces/AdminOfflineRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[AdminOfflineResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminOfflineResponse.md)>

    Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.

    #### Parameters

    <ul>
      <li>
        request: [AdminOfflineRequest](https://docs.kinetica.com/content/api/typescript/interfaces/AdminOfflineRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AdminOfflineResponse](https://docs.kinetica.com/content/api/typescript/interfaces/AdminOfflineResponse.md)>

    Promise\<Types.AdminOfflineResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:2335](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L2335)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.