artifact-keeper-client 1.2.1

Rust client for the Artifact Keeper REST API
Documentation

Rust API client for artifact-keeper-client

Enterprise artifact registry supporting 45+ package formats.

For more information, please visit https://artifactkeeper.com

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.2.1
  • Package version: 1.2.1
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named artifact-keeper-client and add the following to Cargo.toml under [dependencies]:

artifact-keeper-client = { path = "./artifact-keeper-client" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AdminApi cancel_backup POST /api/v1/admin/backups/{id}/cancel Cancel a running backup
AdminApi create_backup POST /api/v1/admin/backups Create backup
AdminApi create_instance POST /api/v1/instances Create a new remote instance
AdminApi delete_backup DELETE /api/v1/admin/backups/{id} Delete a backup
AdminApi delete_instance DELETE /api/v1/instances/{id} Delete a remote instance
AdminApi execute_backup POST /api/v1/admin/backups/{id}/execute Execute a pending backup
AdminApi get_backup GET /api/v1/admin/backups/{id} Get backup by ID
AdminApi get_settings GET /api/v1/admin/settings Get system settings
AdminApi get_system_stats GET /api/v1/admin/stats Get system statistics
AdminApi list_backups GET /api/v1/admin/backups List backups
AdminApi list_instances GET /api/v1/instances List all remote instances for the authenticated user
AdminApi list_storage_backends GET /api/v1/admin/storage-backends List available storage backends.
AdminApi oci_blob_report GET /api/v1/admin/storage-gc/oci-blob-report GET /api/v1/admin/storage-gc/oci-blob-report
AdminApi proxy_delete DELETE /api/v1/instances/{id}/proxy/{path} Proxy a DELETE request to a remote instance
AdminApi proxy_get GET /api/v1/instances/{id}/proxy/{path} Proxy a GET request to a remote instance
AdminApi proxy_post POST /api/v1/instances/{id}/proxy/{path} Proxy a POST request to a remote instance
AdminApi proxy_put PUT /api/v1/instances/{id}/proxy/{path} Proxy a PUT request to a remote instance
AdminApi rescan_for_inventory POST /api/v1/admin/rescan-for-inventory
AdminApi restore_backup POST /api/v1/admin/backups/{id}/restore Restore from backup
AdminApi run_cleanup POST /api/v1/admin/cleanup Run cleanup tasks
AdminApi run_storage_gc POST /api/v1/admin/storage-gc POST /api/v1/admin/storage-gc
AdminApi send_test_email POST /api/v1/admin/smtp/test Send a test email to verify SMTP configuration.
AdminApi trigger_reindex POST /api/v1/admin/reindex Trigger a full OpenSearch reindex of all artifacts and repositories.
AdminApi trigger_search_reindex POST /api/v1/admin/search/reindex Trigger a full reindex of all artifacts and repositories in OpenSearch.
AdminApi update_settings POST /api/v1/admin/settings Update system settings
AnalyticsApi capture_snapshot POST /api/v1/admin/analytics/snapshot POST /api/v1/admin/analytics/snapshot - manually trigger a snapshot
AnalyticsApi get_download_trends GET /api/v1/admin/analytics/downloads/trend GET /api/v1/admin/analytics/downloads/trend
AnalyticsApi get_growth_summary GET /api/v1/admin/analytics/storage/growth GET /api/v1/admin/analytics/storage/growth
AnalyticsApi get_repository_trend GET /api/v1/admin/analytics/repositories/{id}/trend GET /api/v1/admin/analytics/repositories/{id}/trend
AnalyticsApi get_stale_artifacts GET /api/v1/admin/analytics/artifacts/stale GET /api/v1/admin/analytics/artifacts/stale
AnalyticsApi get_storage_breakdown GET /api/v1/admin/analytics/storage/breakdown GET /api/v1/admin/analytics/storage/breakdown
AnalyticsApi get_storage_trend GET /api/v1/admin/analytics/storage/trend GET /api/v1/admin/analytics/storage/trend
ApprovalApi approve_promotion POST /api/v1/approval/{id}/approve Approve a pending promotion request. Admin-only.
ApprovalApi get_approval GET /api/v1/approval/{id} Get a single approval request by ID.
ApprovalApi list_approval_history GET /api/v1/approval/history List approval history with optional filtering by status or source repository.
ApprovalApi list_pending_approvals GET /api/v1/approval/pending List pending approval requests. Optionally filter by source repository.
ApprovalApi reject_promotion POST /api/v1/approval/{id}/reject Reject a pending promotion request. Admin-only.
ApprovalApi request_approval POST /api/v1/approval/request Request approval for promoting an artifact from staging to release.
ArtifactLabelsApi add_artifact_label POST /api/v1/artifacts/{id}/labels/{label_key} Add or update a single label on an artifact
ArtifactLabelsApi delete_artifact_label DELETE /api/v1/artifacts/{id}/labels/{label_key} Delete a label by key from an artifact
ArtifactLabelsApi list_artifact_labels GET /api/v1/artifacts/{id}/labels List all labels on an artifact
ArtifactLabelsApi set_artifact_labels PUT /api/v1/artifacts/{id}/labels Set all labels on an artifact (replaces existing)
ArtifactsApi get_artifact GET /api/v1/artifacts/{id} Get artifact by ID
ArtifactsApi get_artifact_metadata GET /api/v1/artifacts/{id}/metadata Get artifact metadata by artifact ID
ArtifactsApi get_artifact_stats GET /api/v1/artifacts/{id}/stats Get artifact download statistics
AuthApi create_api_token POST /api/v1/auth/tokens Create a new API token for the current user
AuthApi create_download_ticket POST /api/v1/auth/ticket Create a short-lived, single-use download/stream ticket for the current user. The ticket can be passed as a ?ticket= query parameter on endpoints that cannot use Authorization headers (e.g. <a> downloads, EventSource SSE).
AuthApi disable_totp POST /api/v1/auth/totp/disable Disable TOTP for the authenticated user (requires password and current TOTP code)
AuthApi enable_totp POST /api/v1/auth/totp/enable Enable TOTP by verifying the initial code and generating backup codes
AuthApi get_current_user GET /api/v1/auth/me Get current user info
AuthApi login POST /api/v1/auth/login Login with credentials
AuthApi logout POST /api/v1/auth/logout Logout current session
AuthApi refresh_token POST /api/v1/auth/refresh Refresh access token
AuthApi revoke_api_token DELETE /api/v1/auth/tokens/{token_id} Revoke an API token
AuthApi setup_status GET /api/v1/setup/status Returns whether initial setup (password change) is required.
AuthApi setup_totp POST /api/v1/auth/totp/setup Generate a new TOTP secret and QR code URL for the authenticated user
AuthApi verify_totp POST /api/v1/auth/totp/verify Verify TOTP code during login (exchanges totp_token + code for full auth tokens)
BuildsApi add_build_artifacts POST /api/v1/builds/{id}/artifacts Attach artifacts to a build (POST /api/v1/builds/:id/artifacts)
BuildsApi create_build POST /api/v1/builds Create a new build (POST /api/v1/builds)
BuildsApi get_build GET /api/v1/builds/{id} Get a build by ID
BuildsApi get_build_diff GET /api/v1/builds/diff Get diff between two builds
BuildsApi list_builds GET /api/v1/builds List builds
BuildsApi update_build PUT /api/v1/builds/{id} Update build status (PUT /api/v1/builds/:id)
CurationApi approve_package POST /api/v1/curation/packages/{id}/approve
CurationApi block_package POST /api/v1/curation/packages/{id}/block
CurationApi bulk_approve POST /api/v1/curation/packages/bulk-approve
CurationApi bulk_block POST /api/v1/curation/packages/bulk-block
CurationApi create_curation_rule POST /api/v1/curation/rules
CurationApi delete_curation_rule DELETE /api/v1/curation/rules/{id}
CurationApi get_curation_package GET /api/v1/curation/packages/{id}
CurationApi list_curation_packages GET /api/v1/curation/packages
CurationApi list_curation_rules GET /api/v1/curation/rules
CurationApi re_evaluate POST /api/v1/curation/packages/re-evaluate
CurationApi stats GET /api/v1/curation/stats
CurationApi update_curation_rule PUT /api/v1/curation/rules/{id}
EmailSubscriptionsApi create_subscription POST /api/v1/repositories/{key}/email-subscriptions Create an email subscription scoped to a repository.
EmailSubscriptionsApi delete_subscription DELETE /api/v1/repositories/{key}/email-subscriptions/{subscription_id} Delete an email subscription by id.
EmailSubscriptionsApi list_subscriptions GET /api/v1/repositories/{key}/email-subscriptions List the email subscriptions configured on a repository.
GroupsApi add_members POST /api/v1/groups/{id}/members Add members to a group
GroupsApi create_group POST /api/v1/groups Create a group
GroupsApi delete_group DELETE /api/v1/groups/{id} Delete a group
GroupsApi get_group GET /api/v1/groups/{id} Get a group by ID
GroupsApi list_groups GET /api/v1/groups List groups
GroupsApi remove_members DELETE /api/v1/groups/{id}/members Remove members from a group
GroupsApi update_group PUT /api/v1/groups/{id} Update a group
HealthApi health_check GET /health Health check endpoint -- rich status page for dashboards.
HealthApi liveness_check GET /livez Liveness probe - confirms the process is alive and can serve HTTP.
HealthApi metrics GET /api/v1/admin/metrics Prometheus metrics endpoint. Renders all registered metrics from the metrics-exporter-prometheus recorder.
HealthApi readiness_check GET /readyz Readiness probe - is the service ready to accept traffic?
LifecycleApi create_lifecycle_policy POST /api/v1/admin/lifecycle POST /api/v1/admin/lifecycle
LifecycleApi delete_lifecycle_policy DELETE /api/v1/admin/lifecycle/{id} DELETE /api/v1/admin/lifecycle/:id
LifecycleApi execute_all_policies POST /api/v1/admin/lifecycle/execute-all POST /api/v1/admin/lifecycle/execute-all
LifecycleApi execute_policy POST /api/v1/admin/lifecycle/{id}/execute POST /api/v1/admin/lifecycle/:id/execute
LifecycleApi get_lifecycle_policy GET /api/v1/admin/lifecycle/{id} GET /api/v1/admin/lifecycle/:id
LifecycleApi list_lifecycle_policies GET /api/v1/admin/lifecycle GET /api/v1/admin/lifecycle
LifecycleApi preview_policy POST /api/v1/admin/lifecycle/{id}/preview POST /api/v1/admin/lifecycle/:id/preview - dry-run
LifecycleApi update_lifecycle_policy PATCH /api/v1/admin/lifecycle/{id} PATCH /api/v1/admin/lifecycle/:id
MigrationApi cancel_migration POST /api/v1/migrations/{id}/cancel Cancel a migration job
MigrationApi create_connection POST /api/v1/migrations/connections Create a new source connection
MigrationApi create_migration POST /api/v1/migrations Create a new migration job
MigrationApi delete_connection DELETE /api/v1/migrations/connections/{id} Delete a source connection
MigrationApi delete_migration DELETE /api/v1/migrations/{id} Delete a migration job
MigrationApi get_assessment GET /api/v1/migrations/{id}/assessment Get assessment results
MigrationApi get_connection GET /api/v1/migrations/connections/{id} Get a specific source connection
MigrationApi get_migration GET /api/v1/migrations/{id} Get a specific migration job
MigrationApi get_migration_report GET /api/v1/migrations/{id}/report Get migration report
MigrationApi list_connections GET /api/v1/migrations/connections List all source connections for the current user
MigrationApi list_migration_items GET /api/v1/migrations/{id}/items List migration items for a job
MigrationApi list_migrations GET /api/v1/migrations List migration jobs
MigrationApi list_source_repositories GET /api/v1/migrations/connections/{id}/repositories List repositories from Artifactory source
MigrationApi pause_migration POST /api/v1/migrations/{id}/pause Pause a migration job
MigrationApi resume_migration POST /api/v1/migrations/{id}/resume Resume a paused migration job
MigrationApi run_assessment POST /api/v1/migrations/{id}/assess Run pre-migration assessment
MigrationApi start_migration POST /api/v1/migrations/{id}/start Start a migration job
MigrationApi stream_migration_progress GET /api/v1/migrations/{id}/stream Stream migration progress via Server-Sent Events
MigrationApi test_connection POST /api/v1/migrations/connections/{id}/test Test connection to Artifactory
MonitoringApi get_alert_states GET /api/v1/admin/monitoring/alerts GET /api/v1/admin/monitoring/alerts
MonitoringApi get_health_log GET /api/v1/admin/monitoring/health-log GET /api/v1/admin/monitoring/health-log
MonitoringApi run_health_check POST /api/v1/admin/monitoring/check POST /api/v1/admin/monitoring/check - manually trigger health checks
MonitoringApi suppress_alert POST /api/v1/admin/monitoring/alerts/suppress POST /api/v1/admin/monitoring/alerts/suppress
PackagesApi get_package GET /api/v1/packages/{id} Get a package by ID
PackagesApi get_package_versions GET /api/v1/packages/{id}/versions Get package versions
PackagesApi list_packages GET /api/v1/packages List packages
PeerInstanceLabelsApi add_label POST /api/v1/peers/{id}/labels/{label_key} Add or update a single label on a peer instance
PeerInstanceLabelsApi delete_label DELETE /api/v1/peers/{id}/labels/{label_key} Delete a label by key from a peer instance
PeerInstanceLabelsApi list_labels GET /api/v1/peers/{id}/labels List all labels on a peer instance
PeerInstanceLabelsApi set_labels PUT /api/v1/peers/{id}/labels Set all labels on a peer instance (replaces existing)
PeersApi announce_peer POST /api/v1/peers/announce POST /api/v1/peers/announce
PeersApi assign_repo POST /api/v1/peers/{id}/repositories Assign repository to peer instance
PeersApi complete_chunk POST /api/v1/peers/{id}/transfer/{session_id}/chunk/{chunk_index}/complete POST /api/v1/peers/:id/transfer/:session_id/chunk/:chunk_index/complete
PeersApi complete_session POST /api/v1/peers/{id}/transfer/{session_id}/complete POST /api/v1/peers/:id/transfer/:session_id/complete
PeersApi create_sync_policy POST /api/v1/sync-policies Create a new sync policy
PeersApi delete_sync_policy DELETE /api/v1/sync-policies/{id} Delete a sync policy
PeersApi discover_peers GET /api/v1/peers/{id}/connections/discover GET /api/v1/peers/:id/connections/discover
PeersApi evaluate_policies POST /api/v1/sync-policies/evaluate Force re-evaluate all sync policies
PeersApi fail_chunk POST /api/v1/peers/{id}/transfer/{session_id}/chunk/{chunk_index}/fail POST /api/v1/peers/:id/transfer/:session_id/chunk/:chunk_index/fail
PeersApi fail_session POST /api/v1/peers/{id}/transfer/{session_id}/fail POST /api/v1/peers/:id/transfer/:session_id/fail
PeersApi get_assigned_repos GET /api/v1/peers/{id}/repositories Get assigned repositories for peer instance
PeersApi get_chunk_availability GET /api/v1/peers/{id}/chunks/{artifact_id} GET /api/v1/peers/:id/chunks/:artifact_id
PeersApi get_chunk_manifest GET /api/v1/peers/{id}/transfer/{session_id}/chunks GET /api/v1/peers/:id/transfer/:session_id/chunks
PeersApi get_identity GET /api/v1/peers/identity GET /api/v1/peers/identity
PeersApi get_peer GET /api/v1/peers/{id} Get peer instance details
PeersApi get_peers_with_chunks GET /api/v1/peers/{id}/chunks/{artifact_id}/peers GET /api/v1/peers/:id/chunks/:artifact_id/peers
PeersApi get_scored_peers GET /api/v1/peers/{id}/chunks/{artifact_id}/scored-peers GET /api/v1/peers/:id/chunks/:artifact_id/scored-peers
PeersApi get_session GET /api/v1/peers/{id}/transfer/{session_id} GET /api/v1/peers/:id/transfer/:session_id
PeersApi get_subscription GET /api/v1/peers/{id}/repositories/{repo_id} Get full subscription details for a (peer, repo) pair.
PeersApi get_sync_policy GET /api/v1/sync-policies/{id} Get a sync policy by ID
PeersApi get_sync_tasks GET /api/v1/peers/{id}/sync/tasks Get pending sync tasks for peer instance
PeersApi heartbeat POST /api/v1/peers/{id}/heartbeat Heartbeat from peer instance
PeersApi init_transfer POST /api/v1/peers/{id}/transfer/init POST /api/v1/peers/:id/transfer/init
PeersApi list_peer_connections GET /api/v1/peers/{id}/connections GET /api/v1/peers/:id/connections
PeersApi list_peers GET /api/v1/peers List peer instances
PeersApi list_sync_policies GET /api/v1/sync-policies List all sync policies
PeersApi mark_unreachable POST /api/v1/peers/{id}/connections/{target_id}/unreachable POST /api/v1/peers/:id/connections/:target_id/unreachable
PeersApi preview_sync_policy POST /api/v1/sync-policies/preview Preview what a policy would match (dry-run)
PeersApi probe_peer POST /api/v1/peers/{id}/connections/probe POST /api/v1/peers/:id/connections/probe
PeersApi register_peer POST /api/v1/peers Register new peer instance
PeersApi retry_chunk POST /api/v1/peers/{id}/transfer/{session_id}/chunk/{chunk_index}/retry POST /api/v1/peers/:id/transfer/:session_id/chunk/:chunk_index/retry
PeersApi run_subscription_now POST /api/v1/peers/{id}/repositories/{repo_id}/sync Trigger an immediate sync for a single (peer, repo) subscription.
PeersApi toggle_policy POST /api/v1/sync-policies/{id}/toggle Toggle a sync policy (enable/disable)
PeersApi trigger_sync POST /api/v1/peers/{id}/sync Trigger sync for peer instance
PeersApi unassign_repo DELETE /api/v1/peers/{id}/repositories/{repo_id} Unassign repository from peer instance
PeersApi unregister_peer DELETE /api/v1/peers/{id} Unregister peer instance
PeersApi update_chunk_availability PUT /api/v1/peers/{id}/chunks/{artifact_id} PUT /api/v1/peers/:id/chunks/:artifact_id
PeersApi update_network_profile PUT /api/v1/peers/{id}/network-profile PUT /api/v1/peers/:id/network-profile
PeersApi update_sync_policy PUT /api/v1/sync-policies/{id} Update a sync policy
PermissionsApi create_permission POST /api/v1/permissions Create a permission
PermissionsApi delete_permission DELETE /api/v1/permissions/{id} Delete a permission
PermissionsApi get_permission GET /api/v1/permissions/{id} Get a permission by ID
PermissionsApi list_permissions GET /api/v1/permissions List permissions
PermissionsApi update_permission PUT /api/v1/permissions/{id} Update a permission
PluginsApi disable_format_handler POST /api/v1/formats/{format_key}/disable Disable a format handler (T042)
PluginsApi disable_plugin POST /api/v1/plugins/{id}/disable Disable plugin
PluginsApi enable_format_handler POST /api/v1/formats/{format_key}/enable Enable a format handler (T041)
PluginsApi enable_plugin POST /api/v1/plugins/{id}/enable Enable plugin
PluginsApi get_format_handler GET /api/v1/formats/{format_key} Get a format handler by key (T040)
PluginsApi get_plugin GET /api/v1/plugins/{id} Get plugin details
PluginsApi get_plugin_config GET /api/v1/plugins/{id}/config Get plugin configuration
PluginsApi get_plugin_events GET /api/v1/plugins/{id}/events Get plugin events (T026)
PluginsApi install_from_git POST /api/v1/plugins/install/git Install a plugin from a Git repository (T021)
PluginsApi install_from_local POST /api/v1/plugins/install/local Install a plugin from local filesystem path (T063) This endpoint is intended for development use only.
PluginsApi install_from_zip POST /api/v1/plugins/install/zip Install a plugin from a ZIP file (T034)
PluginsApi install_plugin POST /api/v1/plugins Install plugin from uploaded package
PluginsApi list_format_handlers GET /api/v1/formats List all format handlers (T039)
PluginsApi list_plugins GET /api/v1/plugins List installed plugins
PluginsApi reload_plugin POST /api/v1/plugins/{id}/reload Reload a plugin (hot-reload) (T048)
PluginsApi test_format_handler POST /api/v1/formats/{format_key}/test Test a format handler with sample content (T062)
PluginsApi uninstall_plugin DELETE /api/v1/plugins/{id} Uninstall plugin
PluginsApi update_plugin_config POST /api/v1/plugins/{id}/config Update plugin configuration
PromotionApi create_rule POST /api/v1/promotion-rules Create a promotion rule
PromotionApi delete_rule DELETE /api/v1/promotion-rules/{id} Delete a promotion rule
PromotionApi evaluate_rule POST /api/v1/promotion-rules/{id}/evaluate Dry-run evaluate a rule against all artifacts in its source repository
PromotionApi get_release_target GET /api/v1/promotion/repositories/{key}/release-target Get the linked release target for a staging repository.
PromotionApi get_rule GET /api/v1/promotion-rules/{id} Get a promotion rule by ID
PromotionApi list_rules GET /api/v1/promotion-rules List all promotion rules
PromotionApi promote_artifact POST /api/v1/promotion/repositories/{key}/artifacts/{artifact_id}/promote
PromotionApi promote_artifacts_bulk POST /api/v1/promotion/repositories/{key}/promote
PromotionApi promotion_history GET /api/v1/promotion/repositories/{key}/promotion-history
PromotionApi reject_artifact POST /api/v1/promotion/repositories/{key}/artifacts/{artifact_id}/reject
PromotionApi set_release_target PUT /api/v1/promotion/repositories/{key}/release-target Set or remove the linked release target for a staging repository.
PromotionApi update_rule PUT /api/v1/promotion-rules/{id} Update a promotion rule
QualityApi create_gate POST /api/v1/quality/gates
QualityApi delete_gate DELETE /api/v1/quality/gates/{id}
QualityApi evaluate_gate POST /api/v1/quality/gates/evaluate/{artifact_id}
QualityApi get_artifact_health GET /api/v1/quality/health/artifacts/{artifact_id}
QualityApi get_check GET /api/v1/quality/checks/{id}
QualityApi get_gate GET /api/v1/quality/gates/{id}
QualityApi get_health_dashboard GET /api/v1/quality/health/dashboard
QualityApi get_repo_health GET /api/v1/quality/health/repositories/{key}
QualityApi list_check_issues GET /api/v1/quality/checks/{id}/issues
QualityApi list_checks GET /api/v1/quality/checks
QualityApi list_gates GET /api/v1/quality/gates
QualityApi suppress_issue POST /api/v1/quality/issues/{id}/suppress
QualityApi trigger_checks POST /api/v1/quality/checks/trigger
QualityApi unsuppress_issue DELETE /api/v1/quality/issues/{id}/suppress
QualityApi update_gate PUT /api/v1/quality/gates/{id}
QuarantineApi get_quarantine_status GET /api/v1/quarantine/{artifact_id} Get quarantine status for an artifact
QuarantineApi reject_quarantined_artifact POST /api/v1/quarantine/{artifact_id}/reject Reject a quarantined artifact (admin only)
QuarantineApi release_artifact POST /api/v1/quarantine/{artifact_id}/release Release an artifact from quarantine (admin only)
RepositoriesApi add_virtual_member POST /api/v1/repositories/{key}/members Add a member to a virtual repository
RepositoriesApi create_repository POST /api/v1/repositories Create a new repository
RepositoriesApi delete_artifact DELETE /api/v1/repositories/{key}/artifacts/{path} Delete artifact
RepositoriesApi delete_pypi_track DELETE /api/v1/repositories/{key}/pypi-tracks/{project} Remove a PEP 708 tracks declaration, restoring local-precedence isolation for that project name (#1600).
RepositoriesApi delete_repository DELETE /api/v1/repositories/{key} Delete repository
RepositoriesApi delete_routing_rules DELETE /api/v1/repositories/{key}/routing-rules Delete all routing rules for a repository
RepositoriesApi download_artifact GET /api/v1/repositories/{key}/download/{path} Download artifact
RepositoriesApi get_cache_ttl GET /api/v1/repositories/{key}/cache-ttl Get the proxy cache TTL for a repository
RepositoriesApi get_content GET /api/v1/tree/content
RepositoriesApi get_repository GET /api/v1/repositories/{key} Get repository details
RepositoriesApi get_repository_artifact_metadata GET /api/v1/repositories/{key}/artifacts/{path} Get artifact metadata
RepositoriesApi get_routing_rules GET /api/v1/repositories/{key}/routing-rules Get routing rules for a repository
RepositoriesApi get_tree GET /api/v1/tree
RepositoriesApi invalidate_cache POST /api/v1/repositories/{key}/cache/invalidate Invalidate a single cached artifact entry on a Remote (proxy) repository (#1539).
RepositoriesApi list_artifacts GET /api/v1/repositories/{key}/artifacts List artifacts in repository
RepositoriesApi list_pypi_tracks GET /api/v1/repositories/{key}/pypi-tracks List the PEP 708 tracks declarations on a repository.
RepositoriesApi list_repositories GET /api/v1/repositories List repositories
RepositoriesApi list_virtual_members GET /api/v1/repositories/{key}/members List virtual repository members
RepositoriesApi put_pypi_track PUT /api/v1/repositories/{key}/pypi-tracks/{project} Declare (upsert) that a locally-owned PyPI project tracks an upstream one, allowing a virtual repository to merge versions across members for that name instead of isolating it (PEP 708, #1600).
RepositoriesApi remove_virtual_member DELETE /api/v1/repositories/{key}/members/{member_key} Remove a member from a virtual repository
RepositoriesApi set_cache_ttl PUT /api/v1/repositories/{key}/cache-ttl Set the proxy cache TTL for a repository
RepositoriesApi set_routing_rules POST /api/v1/repositories/{key}/routing-rules Set routing rules for a repository
RepositoriesApi set_upstream_auth PUT /api/v1/repositories/{key}/upstream-auth Set or remove upstream auth for a remote repository
RepositoriesApi test_upstream POST /api/v1/repositories/{key}/test-upstream Test connectivity to the upstream URL of a remote repository
RepositoriesApi update_repository PATCH /api/v1/repositories/{key} Update repository
RepositoriesApi update_virtual_members PUT /api/v1/repositories/{key}/members Update priorities for all members (bulk reorder)
RepositoriesApi upload_artifact PUT /api/v1/repositories/{key}/artifacts/{path} Upload artifact
RepositoryLabelsApi add_repo_label POST /api/v1/repositories/{key}/labels/{label_key} Add or update a single label
RepositoryLabelsApi delete_repo_label DELETE /api/v1/repositories/{key}/labels/{label_key} Delete a label by key
RepositoryLabelsApi list_repo_labels GET /api/v1/repositories/{key}/labels List all labels on a repository
RepositoryLabelsApi set_repo_labels PUT /api/v1/repositories/{key}/labels Set all labels on a repository (replaces existing)
RepositoryTokensApi create_repo_token POST /api/v1/repositories/{key}/tokens Create a new access token scoped to a repository.
RepositoryTokensApi get_repo_token GET /api/v1/repositories/{key}/tokens/{token_id} Get details of a specific token on a repository.
RepositoryTokensApi list_repo_tokens GET /api/v1/repositories/{key}/tokens List all access tokens configured on a repository.
RepositoryTokensApi revoke_repo_token DELETE /api/v1/repositories/{key}/tokens/{token_id} Revoke an access token from a repository.
SbomApi check_license_compliance POST /api/v1/sbom/check-compliance Check license compliance against policies
SbomApi convert_sbom POST /api/v1/sbom/{id}/convert Convert an SBOM to a different format
SbomApi delete_license_policy DELETE /api/v1/sbom/license-policies/{id} Delete a license policy
SbomApi delete_sbom DELETE /api/v1/sbom/{id} Delete an SBOM
SbomApi generate_sbom POST /api/v1/sbom Generate an SBOM for an artifact
SbomApi get_cve_history GET /api/v1/sbom/cve/history/{id} Get CVE history by artifact UUID or CVE identifier (legacy overload).
SbomApi get_cve_history_by_artifact GET /api/v1/sbom/cve/history/by-artifact/{artifact_id} Get CVE history for one artifact (typed UUID variant).
SbomApi get_cve_history_by_cve GET /api/v1/sbom/cve/history/by-cve/{cve_id} Get CVE history for one CVE identifier across artifacts (typed CVE-id variant).
SbomApi get_cve_trends GET /api/v1/sbom/cve/trends Get CVE trends and statistics
SbomApi get_license_policy GET /api/v1/sbom/license-policies/{id} Get a license policy by ID
SbomApi get_sbom GET /api/v1/sbom/{id} Get SBOM by ID with full content
SbomApi get_sbom_by_artifact GET /api/v1/sbom/by-artifact/{artifact_id} Get SBOM by artifact ID
SbomApi get_sbom_components GET /api/v1/sbom/{id}/components Get components of an SBOM
SbomApi list_license_policies GET /api/v1/sbom/license-policies List all license policies
SbomApi list_sboms GET /api/v1/sbom List SBOMs with optional filters
SbomApi update_cve_status POST /api/v1/sbom/cve/status/{id} Update CVE status
SbomApi update_cve_status_by_artifact_cve POST /api/v1/sbom/cve/status/by-artifact/{artifact_id}/by-cve/{cve_id} Update CVE status for a synth (scan_findings-derived) Security tab row.
SbomApi upsert_license_policy POST /api/v1/sbom/license-policies Create or update a license policy
SearchApi advanced_search GET /api/v1/search/advanced
SearchApi checksum_search GET /api/v1/search/checksum
SearchApi quick_search GET /api/v1/search/quick
SearchApi recent GET /api/v1/search/recent
SearchApi suggest GET /api/v1/search/suggest
SearchApi trending GET /api/v1/search/trending
SecurityApi acknowledge_finding POST /api/v1/security/findings/{id}/acknowledge
SecurityApi create_policy POST /api/v1/security/policies
SecurityApi delete_policy DELETE /api/v1/security/policies/{id}
SecurityApi dt_status GET /api/v1/dependency-track/status Get Dependency-Track integration status
SecurityApi get_all_scores GET /api/v1/security/scores
SecurityApi get_dashboard GET /api/v1/security/dashboard
SecurityApi get_policy GET /api/v1/security/policies/{id}
SecurityApi get_portfolio_metrics GET /api/v1/dependency-track/metrics/portfolio Get portfolio-level metrics
SecurityApi get_project GET /api/v1/dependency-track/projects/{project_uuid} Get project findings by project UUID
SecurityApi get_project_components GET /api/v1/dependency-track/projects/{project_uuid}/components Get components for a project
SecurityApi get_project_findings GET /api/v1/dependency-track/projects/{project_uuid}/findings Get vulnerability findings for a project
SecurityApi get_project_metrics GET /api/v1/dependency-track/projects/{project_uuid}/metrics Get metrics for a project
SecurityApi get_project_metrics_history GET /api/v1/dependency-track/projects/{project_uuid}/metrics/history Get metrics history for a project
SecurityApi get_project_violations GET /api/v1/dependency-track/projects/{project_uuid}/violations Get policy violations for a project
SecurityApi get_repo_security GET /api/v1/repositories/{key}/security
SecurityApi get_scan GET /api/v1/security/scans/{id}
SecurityApi list_artifact_scans GET /api/v1/security/artifacts/{artifact_id}/scans
SecurityApi list_dependency_track_policies GET /api/v1/dependency-track/policies List all policies
SecurityApi list_findings GET /api/v1/security/scans/{id}/findings
SecurityApi list_policies GET /api/v1/security/policies
SecurityApi list_projects GET /api/v1/dependency-track/projects List all Dependency-Track projects
SecurityApi list_repo_scans GET /api/v1/repositories/{key}/security/scans
SecurityApi list_scan_configs GET /api/v1/security/configs
SecurityApi list_scans GET /api/v1/security/scans
SecurityApi revoke_acknowledgment DELETE /api/v1/security/findings/{id}/acknowledge
SecurityApi trigger_scan POST /api/v1/security/scan
SecurityApi update_analysis PUT /api/v1/dependency-track/analysis Update analysis (triage) for a finding
SecurityApi update_policy PUT /api/v1/security/policies/{id}
SecurityApi update_repo_security PUT /api/v1/repositories/{key}/security
ServiceAccountsApi create_service_account POST /api/v1/service-accounts Create a new service account
ServiceAccountsApi create_token POST /api/v1/service-accounts/{id}/tokens Create a token for a service account
ServiceAccountsApi delete_service_account DELETE /api/v1/service-accounts/{id} Delete a service account
ServiceAccountsApi get_service_account GET /api/v1/service-accounts/{id} Get a service account by ID
ServiceAccountsApi list_service_accounts GET /api/v1/service-accounts List all service accounts
ServiceAccountsApi list_tokens GET /api/v1/service-accounts/{id}/tokens List tokens for a service account
ServiceAccountsApi preview_repo_selector POST /api/v1/service-accounts/repo-selector/preview Preview which repositories match a given repo selector.
ServiceAccountsApi revoke_token DELETE /api/v1/service-accounts/{id}/tokens/{token_id} Revoke a token from a service account
ServiceAccountsApi update_service_account PATCH /api/v1/service-accounts/{id} Update a service account
SigningApi create_key POST /api/v1/signing/keys Create a new signing key.
SigningApi delete_key DELETE /api/v1/signing/keys/{key_id} Delete a signing key.
SigningApi get_key GET /api/v1/signing/keys/{key_id} Get a signing key by ID.
SigningApi get_public_key GET /api/v1/signing/keys/{key_id}/public Get the public key in PEM format (for client import).
SigningApi get_repo_public_key GET /api/v1/signing/repositories/{repo_id}/public-key Get the public key for a repository (convenience endpoint).
SigningApi get_repo_signing_config GET /api/v1/signing/repositories/{repo_id}/config Get signing configuration for a repository.
SigningApi list_keys GET /api/v1/signing/keys List all signing keys, optionally filtered by repository.
SigningApi revoke_key POST /api/v1/signing/keys/{key_id}/revoke Revoke (deactivate) a signing key.
SigningApi rotate_key POST /api/v1/signing/keys/{key_id}/rotate Rotate a signing key — generates new key, deactivates old one.
SigningApi update_repo_signing_config POST /api/v1/signing/repositories/{repo_id}/config Update signing configuration for a repository.
SsoApi create_ldap POST /api/v1/admin/sso/ldap Create a new LDAP provider configuration
SsoApi create_oidc POST /api/v1/admin/sso/oidc Create a new OIDC provider configuration
SsoApi create_saml POST /api/v1/admin/sso/saml Create a new SAML provider configuration
SsoApi delete_ldap DELETE /api/v1/admin/sso/ldap/{id} Delete an LDAP provider configuration
SsoApi delete_oidc DELETE /api/v1/admin/sso/oidc/{id} Delete an OIDC provider configuration
SsoApi delete_saml DELETE /api/v1/admin/sso/saml/{id} Delete a SAML provider configuration
SsoApi exchange_code POST /api/v1/auth/sso/exchange Exchange a short-lived code for access and refresh tokens
SsoApi get_ldap GET /api/v1/admin/sso/ldap/{id} Get LDAP provider configuration by ID
SsoApi get_oidc GET /api/v1/admin/sso/oidc/{id} Get OIDC provider configuration by ID
SsoApi get_saml GET /api/v1/admin/sso/saml/{id} Get SAML provider configuration by ID
SsoApi ldap_login POST /api/v1/auth/sso/ldap/{id}/login Authenticate via LDAP
SsoApi list_ldap GET /api/v1/admin/sso/ldap List all LDAP provider configurations
SsoApi list_oidc GET /api/v1/admin/sso/oidc List all OIDC provider configurations
SsoApi list_providers GET /api/v1/auth/sso/providers List all enabled SSO providers
SsoApi list_saml GET /api/v1/admin/sso/saml List all SAML provider configurations
SsoApi list_sso_providers_admin GET /api/v1/admin/sso/providers List all enabled SSO providers (admin view)
SsoApi oidc_callback GET /api/v1/auth/sso/oidc/{id}/callback Handle OIDC authorization callback
SsoApi oidc_login GET /api/v1/auth/sso/oidc/{id}/login Initiate OIDC login redirect
SsoApi saml_acs POST /api/v1/auth/sso/saml/{id}/acs Handle SAML Assertion Consumer Service (ACS) callback
SsoApi saml_login GET /api/v1/auth/sso/saml/{id}/login Initiate SAML login redirect
SsoApi test_ldap POST /api/v1/admin/sso/ldap/{id}/test Test an LDAP provider connection
SsoApi toggle_ldap PATCH /api/v1/admin/sso/ldap/{id}/toggle Toggle an LDAP provider enabled/disabled
SsoApi toggle_oidc PATCH /api/v1/admin/sso/oidc/{id}/toggle Toggle an OIDC provider enabled/disabled
SsoApi toggle_saml PATCH /api/v1/admin/sso/saml/{id}/toggle Toggle a SAML provider enabled/disabled
SsoApi update_ldap PUT /api/v1/admin/sso/ldap/{id} Update an LDAP provider configuration
SsoApi update_oidc PUT /api/v1/admin/sso/oidc/{id} Update an OIDC provider configuration
SsoApi update_saml PUT /api/v1/admin/sso/saml/{id} Update a SAML provider configuration
SystemApi get_system_config GET /api/v1/system/config Return public runtime configuration.
TelemetryApi delete_crash DELETE /api/v1/admin/telemetry/crashes/{id} DELETE /api/v1/admin/telemetry/crashes/:id
TelemetryApi get_crash GET /api/v1/admin/telemetry/crashes/{id} GET /api/v1/admin/telemetry/crashes/:id
TelemetryApi get_telemetry_settings GET /api/v1/admin/telemetry/settings GET /api/v1/admin/telemetry/settings
TelemetryApi list_crashes GET /api/v1/admin/telemetry/crashes GET /api/v1/admin/telemetry/crashes
TelemetryApi list_pending_crashes GET /api/v1/admin/telemetry/crashes/pending GET /api/v1/admin/telemetry/crashes/pending
TelemetryApi submit_crashes POST /api/v1/admin/telemetry/crashes/submit POST /api/v1/admin/telemetry/crashes/submit
TelemetryApi update_telemetry_settings POST /api/v1/admin/telemetry/settings POST /api/v1/admin/telemetry/settings
UploadsApi cancel DELETE /api/v1/uploads/{session_id}
UploadsApi complete PUT /api/v1/uploads/{session_id}/complete
UploadsApi create_session POST /api/v1/uploads
UploadsApi get_session_status GET /api/v1/uploads/{session_id}
UploadsApi upload_chunk PATCH /api/v1/uploads/{session_id}
UsersApi assign_role POST /api/v1/users/{id}/roles Assign role to user
UsersApi change_password POST /api/v1/users/{id}/password Change user password
UsersApi create_user POST /api/v1/users Create user
UsersApi create_user_api_token POST /api/v1/users/{id}/tokens Create API token
UsersApi delete_user DELETE /api/v1/users/{id} Delete user
UsersApi force_password_change POST /api/v1/users/{id}/force-password-change Force a user to change their password on next login (admin only). Sets must_change_password=true and invalidates existing sessions so the user is prompted immediately on their next login.
UsersApi get_user GET /api/v1/users/{id} Get user details
UsersApi get_user_roles GET /api/v1/users/{id}/roles Get user roles
UsersApi list_user_tokens GET /api/v1/users/{id}/tokens List user's API tokens
UsersApi list_users GET /api/v1/users List users
UsersApi reset_password POST /api/v1/users/{id}/password/reset Reset user password (admin only) Generates a new temporary password and sets must_change_password=true
UsersApi revoke_role DELETE /api/v1/users/{id}/roles/{role_id} Revoke role from user
UsersApi revoke_user_api_token DELETE /api/v1/users/{id}/tokens/{token_id} Revoke API token
UsersApi update_user PATCH /api/v1/users/{id} Update user
WebhooksApi create_webhook POST /api/v1/webhooks Create webhook.
WebhooksApi delete_webhook DELETE /api/v1/webhooks/{id} Delete webhook
WebhooksApi disable_webhook POST /api/v1/webhooks/{id}/disable Disable webhook
WebhooksApi enable_webhook POST /api/v1/webhooks/{id}/enable Enable webhook
WebhooksApi get_webhook GET /api/v1/webhooks/{id} Get webhook by ID
WebhooksApi list_deliveries GET /api/v1/webhooks/{id}/deliveries List webhook deliveries
WebhooksApi list_webhooks GET /api/v1/webhooks List webhooks
WebhooksApi redeliver POST /api/v1/webhooks/{id}/deliveries/{delivery_id}/redeliver Redeliver a failed webhook
WebhooksApi rotate_webhook_secret POST /api/v1/webhooks/{id}/rotate-secret Rotate the signing secret for a webhook.
WebhooksApi test_webhook POST /api/v1/webhooks/{id}/test Test webhook by sending a test payload

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author