Skip to main content

list_configs

List

Returns every configuration stored against a key, oldest first.

Endpoint​

GET /keys/{key}/configs

See the API reference for this endpoint.

This operation needs a Management Key. Pass it as the required user_token keyword argument; the client sends it in the Authorization header. See setup.

Import​

from ideal_postcodes import IdealPostcodes

Call list_configs on the IdealPostcodes client. Path parameters are positional; query and body parameters are keyword-only.

Path Parameters​

NameTypeRequiredDescription
keystryesAPI Key The API Key to retrieve. Begins ak_.

Query Parameters​

None.

Response Type​

from ideal_postcodes.types import ListConfigsResult

Errors​

Unsuccessful HTTP responses raise APIError or a subclass, with the HTTP status and the API error code and message. Connection failures and timeouts raise TransportError. Unexpected responses raise ProtocolError. All derive from ClientError. See error handling.

Example​

list_configs.pypython
from ideal_postcodes import IdealPostcodes

with IdealPostcodes("ak_test") as client:
    configs = client.list_configs("ak_test", user_token="uk_example")