apigee package

Subpackages

• apigee.apiproducts package
  • Submodules
  • apigee.apiproducts.apiproducts module
    • Apiproducts
      • Apiproducts.create_api_product()
      • Apiproducts.delete_api_product()
      • Apiproducts.get_api_product()
      • Apiproducts.list_api_products()
      • Apiproducts.push_apiproducts()
      • Apiproducts.update_api_product()
  • apigee.apiproducts.commands module
  • apigee.apiproducts.serializer module
    • ApiproductsSerializer
      • ApiproductsSerializer.serialize_details()
  • Module contents
• apigee.apis package
  • Submodules
  • apigee.apis.api_puller_with_dependency_extraction module
    • ApiPullerWithDependencyExtraction
      • ApiPullerWithDependencyExtraction.apiproxy_dir
      • ApiPullerWithDependencyExtraction.caches_dir
      • ApiPullerWithDependencyExtraction.export_and_extract_api_proxy()
      • ApiPullerWithDependencyExtraction.export_cache_dependencies()
      • ApiPullerWithDependencyExtraction.export_keyvaluemap_dependencies()
      • ApiPullerWithDependencyExtraction.export_resource_dependencies_using_getattr()
      • ApiPullerWithDependencyExtraction.export_targetserver_dependencies()
      • ApiPullerWithDependencyExtraction.get_apiproxy_files()
      • ApiPullerWithDependencyExtraction.get_cache_dependencies()
      • ApiPullerWithDependencyExtraction.get_keyvaluemap_dependencies()
      • ApiPullerWithDependencyExtraction.get_targetserver_dependencies()
      • ApiPullerWithDependencyExtraction.keyvaluemaps_dir
      • ApiPullerWithDependencyExtraction.targetservers_dir
      • ApiPullerWithDependencyExtraction.working_directory
  • apigee.apis.apis module
    • Apis
      • Apis.delete_api_proxy()
      • Apis.delete_api_proxy_revision()
      • Apis.delete_undeployed_revisions()
      • Apis.deploy_api_proxy_revision()
      • Apis.export_api_proxy()
      • Apis.force_undeploy_api_proxy_revision()
      • Apis.get_api_proxy()
      • Apis.list_api_proxies()
      • Apis.list_api_proxy_revisions()
      • Apis.undeploy_api_proxy_revision()
  • apigee.apis.commands module
  • apigee.apis.deploy module
    • Struct
    • deploy()
    • getDeployments()
    • getElementText()
    • getElementVal()
    • httpCall()
    • main()
    • pathContainsDot()
    • printDeployments()
  • apigee.apis.pull module
  • apigee.apis.serializer module
    • ApisSerializer
      • ApisSerializer.filter_deployed_revisions()
      • ApisSerializer.filter_deployment_details()
      • ApisSerializer.filter_undeployed_revisions()
      • ApisSerializer.serialize_details()
  • Module contents
• apigee.apps package
  • Submodules
  • apigee.apps.apps module
    • Apps
      • Apps.add_api_product_to_key()
      • Apps.create_a_consumer_key_and_secret()
      • Apps.create_developer_app()
      • Apps.create_empty_developer_app()
      • Apps.delete_developer_app()
      • Apps.delete_key_for_a_developer_app()
      • Apps.get_developer_app_details()
      • Apps.get_org_app()
      • Apps.list_apps_for_all_developers()
      • Apps.list_developer_apps()
      • Apps.list_org_apps()
      • Apps.restore_and_update_app_details()
      • Apps.update_key_for_a_developer_app()
  • apigee.apps.commands module
  • apigee.apps.serializer module
    • AppsSerializer
      • AppsSerializer.serialize_details()
  • Module contents
• apigee.backups package
  • Submodules
  • apigee.backups.backups module
    • BackupConfig
      • BackupConfig.api_choices
      • BackupConfig.authentication
      • BackupConfig.environments
      • BackupConfig.org_name
      • BackupConfig.prefix
      • BackupConfig.progress_bar
      • BackupConfig.snapshot_data
      • BackupConfig.snapshot_size
      • BackupConfig.working_directory
      • BackupConfig.working_org_directory
    • Backups
      • Backups.calculate_total_snapshot_size()
      • Backups.close_progress_bar()
      • Backups.create_apiproducts_snapshot()
      • Backups.create_apis_snapshot()
      • Backups.create_apps_snapshot()
      • Backups.create_caches_snapshot()
      • Backups.create_developers_snapshot()
      • Backups.create_keyvaluemaps_snapshot()
      • Backups.create_snapshot()
      • Backups.create_targetservers_snapshot()
      • Backups.create_userroles_snapshot()
      • Backups.download_and_save_apiproducts()
      • Backups.download_and_save_apis()
      • Backups.download_and_save_apps()
      • Backups.download_and_save_caches()
      • Backups.download_and_save_developers()
      • Backups.download_and_save_keyvaluemaps()
      • Backups.download_and_save_targetservers()
      • Backups.download_and_save_userroles()
      • Backups.download_resource_permissions()
      • Backups.download_users_for_a_role()
      • Backups.export_and_extract_api()
      • Backups.fetch_and_generate_snapshots()
      • Backups.filter_empty_values()
      • Backups.filter_userroles()
      • Backups.generate_snapshot_files()
      • Backups.generate_snapshot_files_and_download_data()
      • Backups.get_api_details()
      • Backups.get_apiproduct_content()
      • Backups.get_apiproduct_path()
      • Backups.get_app_path()
      • Backups.get_cache_information()
      • Backups.get_cache_path()
      • Backups.get_developer_app_details()
      • Backups.get_developer_details()
      • Backups.get_developer_path()
      • Backups.get_full_path()
      • Backups.get_keyvaluemap_content()
      • Backups.get_keyvaluemap_path()
      • Backups.get_output_file_path()
      • Backups.get_resource_permissions_content()
      • Backups.get_targetserver_content()
      • Backups.get_targetserver_path()
      • Backups.get_users_for_a_role_content()
      • Backups.handle_api_export_error()
      • Backups.handle_apiproduct_download_error()
      • Backups.handle_app_download_error()
      • Backups.handle_cache_download_error()
      • Backups.handle_developer_download_error()
      • Backups.handle_general_exception()
      • Backups.handle_keyvaluemap_download_error()
      • Backups.handle_targetserver_download_error()
      • Backups.increment_progress_bar()
      • Backups.initialize_progress_bar()
      • Backups.list_all_developers()
      • Backups.list_api_products()
      • Backups.list_api_proxies()
      • Backups.list_apps_for_developers()
      • Backups.list_caches_in_environment()
      • Backups.list_keyvaluemaps_in_environment()
      • Backups.list_targetservers_in_environment()
      • Backups.list_user_roles()
      • Backups.retrieve_listing()
      • Backups.save_apiproducts_snapshot()
      • Backups.save_apis_snapshot()
      • Backups.save_apps_snapshot()
      • Backups.save_caches_snapshot()
      • Backups.save_content_to_file()
      • Backups.save_keyvaluemaps_snapshot()
      • Backups.save_targetservers_snapshot()
      • Backups.save_userroles_snapshot()
      • Backups.set_progress_bar_description()
      • Backups.update_progress_bar()
  • apigee.backups.commands module
  • Module contents
• apigee.caches package
  • Submodules
  • apigee.caches.caches module
    • Caches
      • Caches.clear_a_cache_entry()
      • Caches.clear_all_cache_entries()
      • Caches.create_a_cache_in_an_environment()
      • Caches.delete_a_cache()
      • Caches.get_information_about_a_cache()
      • Caches.list_caches_in_an_environment()
      • Caches.push_cache()
      • Caches.update_a_cache_in_an_environment()
  • apigee.caches.commands module
  • apigee.caches.serializer module
    • CachesSerializer
      • CachesSerializer.serialize_details()
  • Module contents
• apigee.configure package
  • Submodules
  • apigee.configure.commands module
    • HiddenSecret
  • Module contents
• apigee.deployments package
  • Submodules
  • apigee.deployments.commands module
  • apigee.deployments.deployments module
    • Deployments
      • Deployments.get_api_proxy_deployment_details()
      • Deployments.get_shared_flow_deployment_details()
  • apigee.deployments.serializer module
    • DeploymentsSerializer
      • DeploymentsSerializer.serialize_details()
  • Module contents
• apigee.developers package
  • Submodules
  • apigee.developers.commands module
  • apigee.developers.developers module
    • Developers
      • Developers.create_developer()
      • Developers.delete_developer()
      • Developers.delete_developer_attribute()
      • Developers.get_all_developer_attributes()
      • Developers.get_developer()
      • Developers.get_developer_attribute()
      • Developers.get_developer_by_app()
      • Developers.list_developers()
      • Developers.set_developer_status()
      • Developers.update_a_developer_attribute()
      • Developers.update_all_developer_attributes()
      • Developers.update_developer()
  • apigee.developers.serializer module
    • DevelopersSerializer
      • DevelopersSerializer.serialize_details()
  • Module contents
• apigee.keystores package
  • Submodules
  • apigee.keystores.commands module
  • apigee.keystores.keystores module
    • Keystores
      • Keystores.export_a_cert()
      • Keystores.export_a_certificate_for_an_alias()
      • Keystores.get_a_keystore_or_truststore()
      • Keystores.get_alias()
      • Keystores.get_all_certs_from_a_keystore_or_truststore()
      • Keystores.get_cert_details_from_a_keystore_or_truststore()
      • Keystores.list_aliases()
      • Keystores.list_all_keystores_and_truststores()
  • apigee.keystores.serializer module
    • KeystoresSerializer
      • KeystoresSerializer.serialize_details()
  • Module contents
• apigee.keyvaluemaps package
  • Submodules
  • apigee.keyvaluemaps.commands module
  • apigee.keyvaluemaps.keyvaluemaps module
    • Keyvaluemaps
      • Keyvaluemaps.create_an_entry_in_an_environment_scoped_kvm()
      • Keyvaluemaps.create_keyvaluemap_in_an_environment()
      • Keyvaluemaps.create_or_update_entry()
      • Keyvaluemaps.decrypt_keyvaluemap()
      • Keyvaluemaps.decrypt_value()
      • Keyvaluemaps.delete_entries()
      • Keyvaluemaps.delete_keyvaluemap_entry_in_an_environment()
      • Keyvaluemaps.delete_keyvaluemap_from_an_environment()
      • Keyvaluemaps.encrypt_keyvaluemap()
      • Keyvaluemaps.encrypt_value()
      • Keyvaluemaps.fetch_keys_in_environment_scoped_keyvaluemap()
      • Keyvaluemaps.find_deleted_keys()
      • Keyvaluemaps.get_a_keys_value_in_an_environment_scoped_keyvaluemap()
      • Keyvaluemaps.get_keyvaluemap_in_an_environment()
      • Keyvaluemaps.list_keys_in_an_environment_scoped_keyvaluemap()
      • Keyvaluemaps.list_keyvaluemaps_in_an_environment()
      • Keyvaluemaps.push_keyvaluemap()
      • Keyvaluemaps.send_delete_request()
      • Keyvaluemaps.synchronize_keyvaluemap_with_environment()
      • Keyvaluemaps.update_an_entry_in_an_environment_scoped_kvm()
      • Keyvaluemaps.update_keyvaluemap_in_an_environment()
    • get_tqdm_kwargs()
  • apigee.keyvaluemaps.serializer module
    • KeyvaluemapsSerializer
      • KeyvaluemapsSerializer.serialize_details()
  • Module contents
• apigee.maskconfigs package
  • Submodules
  • apigee.maskconfigs.commands module
  • apigee.maskconfigs.maskconfigs module
    • Maskconfigs
      • Maskconfigs.create_data_masks_for_an_api_proxy()
      • Maskconfigs.delete_data_masks_for_an_api_proxy()
      • Maskconfigs.fetch_data_masks_for_organization()
      • Maskconfigs.get_data_mask_details_for_an_api_proxy()
      • Maskconfigs.list_data_masks_for_an_api_proxy()
      • Maskconfigs.list_data_masks_for_an_organization()
      • Maskconfigs.push_data_masks_for_an_api_proxy()
  • apigee.maskconfigs.serializer module
    • MaskconfigsSerializer
      • MaskconfigsSerializer.serialize_details()
  • Module contents
• apigee.permissions package
  • Submodules
  • apigee.permissions.commands module
  • apigee.permissions.permissions module
    • Permissions
      • Permissions.apply_team_permissions_template()
      • Permissions.create_role_permissions()
      • Permissions.get_permissions()
      • Permissions.send_create_role_permissions_request()
  • apigee.permissions.serializer module
    • PermissionsSerializer
      • PermissionsSerializer.serialize_details()
  • Module contents
• apigee.plugins package
  • Submodules
  • apigee.plugins.commands module
    • chmod_directory()
    • clone_plugin_repositories()
    • exit_quietly_if_git_not_installed()
    • initialize_and_save_plugin_config()
    • initialize_apigee_cli_plugins()
    • load_plugin_config()
    • prune_unused_plugin_directories()
    • update_plugin_repositories()
  • Module contents
• apigee.references package
  • Submodules
  • apigee.references.commands module
  • apigee.references.references module
    • References
      • References.fetch_reference_data()
      • References.get_reference()
      • References.list_all_references()
  • apigee.references.serializer module
    • ReferencesSerializer
      • ReferencesSerializer.serialize_details()
  • Module contents
• apigee.sharedflows package
  • Submodules
  • apigee.sharedflows.commands module
  • apigee.sharedflows.serializer module
    • SharedflowsSerializer
      • SharedflowsSerializer.filter_deployed_revisions()
      • SharedflowsSerializer.filter_deployment_details()
      • SharedflowsSerializer.filter_undeployed_revisions()
      • SharedflowsSerializer.serialize_details()
  • apigee.sharedflows.sharedflows module
    • Sharedflows
      • Sharedflows.delete_a_shared_flow_revision()
      • Sharedflows.delete_or_undeploy_a_shared_flow()
      • Sharedflows.delete_undeployed_revisions()
      • Sharedflows.deploy_a_shared_flow()
      • Sharedflows.export_shared_flow()
      • Sharedflows.fetch_shared_flow_revisions()
      • Sharedflows.get_a_list_of_shared_flows()
      • Sharedflows.get_a_shared_flow()
      • Sharedflows.get_deployment_environments_for_shared_flows()
      • Sharedflows.get_shared_flow_deployments()
      • Sharedflows.get_shared_flow_revisions()
      • Sharedflows.get_the_shared_flow_attached_to_a_flow_hook()
      • Sharedflows.import_a_shared_flow()
      • Sharedflows.retrieve_shared_flow_revisions()
      • Sharedflows.undeploy_a_shared_flow()
      • Sharedflows.undeploy_shared_flow_revisions_in_environment()
  • Module contents
• apigee.targetservers package
  • Submodules
  • apigee.targetservers.commands module
  • apigee.targetservers.serializer module
    • TargetserversSerializer
      • TargetserversSerializer.serialize_details()
  • apigee.targetservers.targetservers module
    • Targetservers
      • Targetservers.create_a_targetserver()
      • Targetservers.delete_a_targetserver()
      • Targetservers.fetch_target_server_data()
      • Targetservers.get_targetserver()
      • Targetservers.list_targetservers_in_an_environment()
      • Targetservers.push_targetserver()
      • Targetservers.update_a_targetserver()
  • Module contents
• apigee.userroles package
  • Submodules
  • apigee.userroles.commands module
  • apigee.userroles.userroles module
    • Userroles
      • Userroles.add_a_user_to_a_role()
      • Userroles.add_permissions_for_a_resource_to_a_user_role()
      • Userroles.add_permissions_for_multiple_resources_to_a_user_role()
      • Userroles.add_permissions_for_multiple_resources_to_user_role()
      • Userroles.create_a_user_role_in_an_organization()
      • Userroles.create_user_role_in_organization()
      • Userroles.delete_a_permission_for_a_resource()
      • Userroles.delete_a_user_role()
      • Userroles.delete_resource_from_permissions()
      • Userroles.get_a_role()
      • Userroles.get_resource_permissions_for_a_specific_role()
      • Userroles.get_users_for_a_role()
      • Userroles.list_permissions_for_a_resource()
      • Userroles.list_user_roles()
      • Userroles.remove_user_membership_from_role()
      • Userroles.remove_user_membership_in_role()
      • Userroles.sort_resource_permissions()
      • Userroles.verify_a_user_roles_permission_on_a_specific_RBAC_resource()
      • Userroles.verify_and_fetch_user_role_membership()
      • Userroles.verify_user_role_membership()
  • Module contents
• apigee.virtualhosts package
  • Submodules
  • apigee.virtualhosts.commands module
  • apigee.virtualhosts.serializer module
    • VirtualhostsSerializer
      • VirtualhostsSerializer.serialize_details()
  • apigee.virtualhosts.virtualhosts module
    • Virtualhosts
      • Virtualhosts.get_a_virtual_host_for_an_environment()
      • Virtualhosts.list_virtual_hosts_for_an_environment()
  • Module contents

Submodules

apigee.auth module

apigee.auth.attach_is_token_option(func, profile)

apigee.auth.attach_mfa_secret_option(func, profile)

apigee.auth.attach_org_option(func, profile)

apigee.auth.attach_password_option(func, profile)

apigee.auth.attach_username_option(func, profile)

apigee.auth.attach_zonename_option(func, profile)

apigee.auth.common_auth_options(func)

apigee.auth.generate_authentication(username=None, password=None, mfa_secret=None, token=None, zonename=None)

apigee.auth.generate_authentication_error_message(authentication_error)

apigee.auth.get_access_token(auth, username, password, oauth_url, post_headers, session, passcode)

apigee.auth.get_access_token_for_mfa(auth, username, password, oauth_url, post_headers, session)

apigee.auth.get_access_token_for_sso(auth, username, password, oauth_url, post_headers, session, passcode)

apigee.auth.get_access_token_for_token(auth, username, password, oauth_url, post_headers, session)

apigee.auth.get_config_value(config_section, config_key)

apigee.auth.get_sso_temporary_authentication_code(passcode_url)

apigee.auth.retrieve_access_token(authentication, passcode=None)

apigee.auth.set_authentication_headers(authentication_object, custom_headers=None)

apigee.auth.validate_access_token(authentication_object)

apigee.auth.validate_jwt_token(authentication_object, file_name, username_field)

apigee.auth.validate_refresh_token(authentication_object)

apigee.cls module

class apigee.cls.AliasedGroup(name: str | None = None, commands: Dict[str, Command] | Sequence[Command] | None = None, **attrs: Any)

Bases: Group

get_command(ctx, cmd_name)

Given a context and a command name, this returns a Command object if it exists or returns None.

apigee.console module

apigee.console.echo(*message, exit_status=None, make_silent=False, current_verbosity=0, expected_verbosity=0, line_ending='\n', should_flush=False)

apigee.crypto module

apigee.crypto.decrypt_message(secret, message, encoded=True)

apigee.crypto.encrypt_message(secret, message, encoded=True)

apigee.crypto.is_encrypted(message)

apigee.encryption_utils module

apigee.encryption_utils.decrypt_message_with_gpg(secret, message, encoded=True)

apigee.encryption_utils.encrypt_message_with_gpg(secret, message, encoded=True)

apigee.encryption_utils.has_encrypted_header(message)

apigee.exceptions module

exception apigee.exceptions.InvalidApisError

Bases: Exception

apigee.exceptions.configure_global_logger(log_file)

apigee.exceptions.log_and_echo_http_error(error, append_message='')

apigee.exceptions.wrap_with_exception_handling(func)

apigee.prefix module

apigee.prefix.common_prefix_options(func)

apigee.silent module

apigee.silent.common_silent_options(func)

apigee.silent.silent_callback(ctx, param, value)

apigee.types module

class apigee.types.Struct(**entries)

Bases: object

apigee.types.empty_snapshot()

apigee.utils module

apigee.utils.apply_function_on_iterable(iterable, func, state_op='append', args=(), kwargs=None)

apigee.utils.check_file_exists(file)

apigee.utils.check_files_exist(files)

apigee.utils.create_directory(path)

apigee.utils.create_empty_file(path)

apigee.utils.ensure_set(iterable)

apigee.utils.execute_function_on_directory_files(dir, func, glob='**/*', args=(), kwargs=None)

apigee.utils.extract_zip_file(source, dest)

apigee.utils.filter_out_empty_values(dictionary)

apigee.utils.get_resolved_directory_path(target_directory=None)

apigee.utils.import_plugins_from_directory(plugins_init_file, existing_commands)

apigee.utils.is_directory(d)

apigee.utils.is_regular_file(f)

apigee.utils.merge_dict_values(options_dict, initial_dict=None)

apigee.utils.read_file_content(file, type='text')

apigee.utils.remove_file_if_above_size(file, size_kb=100)

apigee.utils.remove_last_elements(init_list, integer=0)

apigee.utils.show_message(msg)

apigee.utils.split_path_by_delimiter(path, delimiter='[/\\\\]')

apigee.utils.write_content_to_file(content, file_path, write_to_filesystem=True, indentation=None, append_eof=True)

apigee.utils.write_content_to_zip(file, content)

apigee.utils_init module

apigee.utils_init.is_truthy_envvar(value)

apigee.utils_init.join_path_components(*components)

apigee.verbose module

apigee.verbose.common_verbose_options(func)

apigee.verbose.verbose_callback(ctx, param, value)

Module contents