admin_get_config

Retrieve current config settings

Functions

async pydelfini.delfini_core.api.admin.admin_get_config.asyncio(*, client)[source]

Retrieve current config settings

Retrieve all current config settings. Administrator access required.

Raises:
  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[SystemConfiguration]

Parameters:

client (AuthenticatedClient)

Return type:

SystemConfiguration

async pydelfini.delfini_core.api.admin.admin_get_config.asyncio_detailed(*, client)[source]

Retrieve current config settings

Retrieve all current config settings. Administrator access required.

Raises:
  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[ServerError, SystemConfiguration]]

Parameters:

client (AuthenticatedClient)

Return type:

Response[ServerError | SystemConfiguration]

pydelfini.delfini_core.api.admin.admin_get_config.sync(*, client)[source]

Retrieve current config settings

Retrieve all current config settings. Administrator access required.

Raises:
  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[SystemConfiguration]

Parameters:

client (AuthenticatedClient)

Return type:

SystemConfiguration

pydelfini.delfini_core.api.admin.admin_get_config.sync_detailed(*, client)[source]

Retrieve current config settings

Retrieve all current config settings. Administrator access required.

Raises:
  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[ServerError, SystemConfiguration]]

Parameters:

client (AuthenticatedClient)

Return type:

Response[ServerError | SystemConfiguration]