Function createAdminApiClient

Returns {
    alias: (args: AliasParameters) => Promise<void>;
    aliasChain: (args: AliasChainParameters) => Promise<void>;
    extend: <const client extends { [key: string]: unknown }>(
        fn: (
            client: {
                alias: ...;
                aliasChain: ...;
                extend: ...;
                getChainAliases: ...;
                getLoggerLevel: ...;
                loadVMs: ...;
                lockProfile: ...;
                memoryProfile: ...;
                setLoggerLevel: ...;
                startCPUProfiler: ...;
                stopCPUProfiler: ...;
            },
        ) => client,
    ) => { [K in (...)
    | (...)
    | (...)]: (...)[(...)] };
    getChainAliases: (args: GetChainAliasesParameters) => Promise<GetChainAliasesReturnType>;
    getLoggerLevel: (args: GetLoggerLevelParameters) => Promise<GetLoggerLevelReturnType>;
    loadVMs: () => Promise<LoadVMsReturnType>;
    lockProfile: () => Promise<void>;
    memoryProfile: () => Promise<void>;
    setLoggerLevel: (args: SetLoggerLevelParameters) => Promise<void>;
    startCPUProfiler: () => Promise<void>;
    stopCPUProfiler: () => Promise<void>;
}

An Admin API Client. AdminApiClient

• alias: (args: AliasParameters) => Promise<void>

  Assign an API endpoint an alias, a different endpoint for the API. The original endpoint will still work. This change only affects this node.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#adminalias

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  await client.admin.alias({
    endpoint: "bc/X",
    alias: "myAlias"
  })
  Copy

• aliasChain: (args: AliasChainParameters) => Promise<void>

  Give a blockchain an alias, a different name that can be used any place the blockchain's ID is used. Note: The alias is set for each chain on each node individually.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#adminaliaschain

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  await client.admin.aliasChain({
    chain: "sV6o671RtkGBcno1FiaDbVcFv2sG5aVXMZYzKdP4VQAWmJQnM",
    alias: "myBlockchainAlias"
  })
  Copy

• extend: <const client extends { [key: string]: unknown }>(
      fn: (
          client: {
              alias: ...;
              aliasChain: ...;
              extend: ...;
              getChainAliases: ...;
              getLoggerLevel: ...;
              loadVMs: ...;
              lockProfile: ...;
              memoryProfile: ...;
              setLoggerLevel: ...;
              startCPUProfiler: ...;
              stopCPUProfiler: ...;
          },
      ) => client,
  ) => { [K in (...)
  | (...)
  | (...)]: (...)[(...)] }

• getChainAliases: (args: GetChainAliasesParameters) => Promise<GetChainAliasesReturnType>

  Returns the aliases of the chain.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#admingetchainaliases

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const aliases = await client.admin.getChainAliases({
    chain: "sV6o671RtkGBcno1FiaDbVcFv2sG5aVXMZYzKdP4VQAWmJQnM"
  })
  Copy

• getLoggerLevel: (args: GetLoggerLevelParameters) => Promise<GetLoggerLevelReturnType>

  Returns log and display levels of loggers.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#admingetloggerlevel

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const loggerLevels = await client.admin.getLoggerLevel({
    loggerName: "C"
  })
  Copy

• loadVMs: () => Promise<LoadVMsReturnType>

  Dynamically loads any virtual machines installed on the node as plugins.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#adminloadvms

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const vms = await client.admin.loadVMs()
  Copy

• lockProfile: () => Promise<void>

  Writes a profile of mutex statistics to lock.profile.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#adminlockprofile

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  await client.admin.lockProfile()
  Copy

• memoryProfile: () => Promise<void>

  Writes a memory profile of the node to mem.profile.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#adminmemoryprofile

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  await client.admin.memoryProfile()
  Copy

• setLoggerLevel: (args: SetLoggerLevelParameters) => Promise<void>

  Sets log and display levels of loggers.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#adminsetloggerlevel

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  await client.admin.setLoggerLevel({
    loggerName: "C",
    logLevel: "DEBUG",
    displayLevel: "INFO"
  })
  Copy

• startCPUProfiler: () => Promise<void>

  Start profiling the CPU utilization of the node. To stop, call stopCPUProfiler. On stop, writes the profile to cpu.profile.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#adminstartcpuprofiler

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  await client.admin.startCPUProfiler()
  Copy

• stopCPUProfiler: () => Promise<void>

  Stop the CPU profile that was previously started.

  • Docs: https://build.avax.network/docs/api-reference/admin-api#adminstopcpuprofiler

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  await client.admin.stopCPUProfiler()
  Copy

import { createAdminApiClient} from '@avalanche-sdk/client'
import { avalanche } from '@avalanche-sdk/client/chains'

const client = createAdminApiClient({
  chain: avalanche,
  transport: {
    type: "http",
    url: "https://api.avax.network/ext/admin",
  },
})

// Set endpoint alias
const alias = await client.alias({ endpoint: "bc/X", alias: "myAlias" })
Copy