Skip to content

Changelog

This page contains a detailed history of changes and update to the Pixel Python API client library (pixel-client)

Versioning follows Semantic Versioning.

Changelog follows the Keep a Changelog 1.1.0 standard.

[1.3.0] - 29-10-2026

Added

  • Access management. See the Access management documentation.
    • People: create_user, update_user, get_user, list_users and paginate_users. Users can be given by ID or email address everywhere.
    • Groups: create_group, list_groups, get_group, update_group, delete_group, add_group_members, remove_group_member and set_group_admin.
    • Project access: grant_project_access and revoke_project_access give or remove a role for many users and groups on many projects in one call. A grant sets the role, also when that lowers it. list_project_users and list_project_groups list who has a role directly on a project.
    • create_project takes groups to give groups a role on the new project as it is created.
    • Generic grants: grant_access_on and revoke_access_on, with the resources ProjectResource and ArcgisServiceResource.
    • Api keys: create_api_key, list_api_keys, rename_api_key, revoke_api_key and replace_api_key. A key can get project roles, follow groups, or get an organisation-wide base role.
    • Geo service users: create_geo_service_user, list_geo_service_users, get_geo_service_user, update_geo_service_user, disable_geo_service_user, enable_geo_service_user, rotate_geo_service_user_password and delete_geo_service_user.
    • ArcGIS service access for geo service users: grant_arcgis_service_access, revoke_arcgis_service_access and list_arcgis_service_access.
    • Inspecting access: list_roles, get_role, list_permissions, list_grants, paginate_grants, get_user_access and get_group_access.
    • PixelAccessUpdateError, raised when an access change that needs several requests partly fails. It lists the changes that succeeded and the ones that failed.
    • Types in pixel_client.types: RoleType (the project roles viewer, editor and admin), BaseRoleType (organisation-wide roles for api keys), UserType, UserRef and GeoServiceUserRef.
    • Models: ProjectResource, ArcgisServiceResource, ApiKeyCreateInput, ApiKeyProjectGrant, ApiKeyGroupGrant, ApiKeyRootGrant, GeoServiceUserCreateInput, GroupCreateInput, GroupUpdateInput, GroupListParams, GroupMemberInput, GroupMembershipInput and UserListParams.
  • Api key authentication. Set PIXEL_API_KEY instead of PIXEL_USERNAME / PIXEL_PASSWORD, or pass api_key= to the client directly. See Installation and Setup.
  • is_public on ArcgisServiceCreateInput and ArcgisServiceUpdateInput, to allow anonymous access to an ArcGIS service.
  • pause_analysis_task and resume_analysis_task, and the task statuses PAUSING and PAUSED.
  • list_analysis_service_field_options, which lists the allowed values for a field of an analysis service's config or task parameters.

Changed

  • PIXEL_USERNAME and PIXEL_PASSWORD are no longer required on their own. Settings now require exactly one set of credentials: either PIXEL_API_KEY, or both PIXEL_USERNAME and PIXEL_PASSWORD.
  • update_oidc_user takes the user's email address instead of their ID.
  • OIDCUserCreateInput takes groups, the groups a new user is added to.

Fixed

  • create_oidc_user and update_oidc_user call /users/ and /users/{email}, the routes the API serves.
  • start_harvest_service and stop_harvest_service use PUT, as the API expects.
  • move_point_cloud uses PUT with query parameters, as the API expects, and takes an optional new_project_id to move a point cloud to a data collection in another project.
  • The synchronous client (PixelClient) now works on Python 3.14 and newer. It runs on its own event loop instead of the thread's current one, which 3.14 no longer creates on demand.

Deprecated

  • create_oidc_user and update_oidc_user emit a DeprecationWarning. Use create_user and update_user instead. update_user keeps the user's active status, whereas update_oidc_user re-activates a deactivated user unless enabled=False is set.

[1.2.8] - 02-06-2026

Added

  • Analysis client surface: list/create/patch/delete analysis services, list/create/run/revoke/delete analysis tasks, and list analysis modules. See the Analysis documentation.

[1.2.7] - 06-03-2026

Fixed

  • Fix correct endpoint for move operations

[1.2.6] - 06-03-2026

Added

  • Point cloud data and point cloud data collections support in Pixel Python API client library
  • Add move methods for images, rasters and point clouds

[1.2.5] - 11-11-2025

Fixed

  • Allow filter on None-type in search functionality

[1.2.4] - 10-11-2025

Added

  • Search functionality for images, rasters, projects and data collections

[1.2.3] - 05-11-2025

Fixed

  • Simplify required env vars

[1.2.2] - 05-11-2025

Fixed

  • Better concurrency management for multipart uploads

[1.2.1] - 02-09-2025

Fixed

  • Added missing dependency packaging to project

[1.2.0] - 11-08-2025

Image service functionality beta release.

Added

  • Restore and list deleted projects and data collections
  • Added option to expose either blurred of original images in ArcGIS Server service
  • Official beta release of Image service functionality

[1.1.0] - 17-06-2025

First release.

Added

  • Initial release of the Pixel Python API client library (pixel-client)
  • Functionality for interacting with the Geodata Pixel API
  • Documentation for the Python client library