# api-reference Documentation > Documentation for api-reference ## Guides - [GitHub](https://apis.appdome.com/docs/github.md) - [GitLab](https://apis.appdome.com/docs/gitlab.md) - [Azure Devops](https://apis.appdome.com/docs/azuredevops.md) ## API Reference - [Appdome Audit Log - Team Events](https://apis.appdome.com/reference/get_events.md):

DEV-Logs™ REST API for versioning and auditing purposes.

The fields parameter is used to filter the fields that are returned in the response.

When fields is provided, timestamp is always included and missing fields are not included in the response.

The fields are dynamic depending on the response, for example: "data.message_policy.debuggable.serverMode,data.message_policy.emulator_detection.mode"

- [Compare Fusion Set](https://apis.appdome.com/reference/get_fusion-set-compare.md): REST API for Comparing Two Fusion Sets - [Delete Apps](https://apis.appdome.com/reference/delete_my-library-apps.md): Delete Apps from the Appdome Platform. - [List Apps](https://apis.appdome.com/reference/get_my-library-apps.md): List personal or teams apps on the Appdome platform. - [Export Fusion Set as JSON](https://apis.appdome.com/reference/get_fusion-set-fusionsetid-export-json.md): Export Fusion Set as JSON on the Appdome Platform. - [Fusion Set History](https://apis.appdome.com/reference/get_fusion-set-history.md): REST API for Comparing Fusion Set History Fusion Set History per License The availability of Fusion Set History varies depending on your license level: - [Get Active Sessions](https://apis.appdome.com/reference/get_sessions-limit.md): Returns number of Active Session and allowed limit. - [Refresh Appdome’s Build2Secure API Token](https://apis.appdome.com/reference/post_refreshapitoken.md): This API generates a new Appdome’s Build2Secure API Token for the specified user. - [Release Fusion Set](https://apis.appdome.com/reference/post_release-fs-fs-id.md): Releases a fusion set from one team to another. Requires the user to be a member of both teams. - [Get AWS Upload Link](https://apis.appdome.com/reference/get_upload-link.md): This endpoint generates a unique, time-limited URL for Amazon Web Services (AWS) to upload an app or SDK securely. It provides both the URL and a file ID necessary for the upload After receiving the URL, send a PUT request with the app or SDK you wish to upload in the request body. The URL expires after 30 minutes to maintain security.

Steps to Use this Endpoint:

1. Obtain Your API Key:

To authenticate API requests, you will need an API key, which can be obtained from your Appdome account. Follow these steps:

  1. Log in to your Appdome account.
  2. Navigate to the 'User Menu' or 'API' section.
  3. Look for an option labeled 'Account and API.'
  4. Copy your Appdome’s Build2Secure API Token.

2. Make the GET Request:

Use the API key to authenticate your request by including it in the Authorization header as a bearer token.

3. Handle the Response:

Upon a successful request, you will receive a JSON response containing the public link, the file ID, and the time until the link expires.

- [Upload to AWS](https://apis.appdome.com/reference/put_amazon-upload-link.md): This endpoint allows you to upload an app or SDK to a public AWS URL obtained from the "Get Public Link" request. The URL serves as the endpoint for this PUT request. Ensure that the app or SDK you want to upload is included in the request body. The link will expire after a pre-defined period of 30 minutes, so the upload must be completed within this timeframe. - [After Uploading to AWS](https://apis.appdome.com/reference/post_upload-using-link.md): It allows you to upload the App/SDK from the AWS server into Appdome. - [Get Upload Status](https://apis.appdome.com/reference/get_upload-app-id-status.md): Returns the status of the upload. The status can be one of the following: 1. queued – the upload is waiting to be processed. 1. progress – the upload is still in progress. 2. completed – the upload was completed successfully. 3. error – the upload failed. In case of error, the response will include an error message under `error` key. - [Build an App/SDK ](https://apis.appdome.com/reference/post_tasks-build.md): This API allows you to build and customize a mobile app or SDK after uploading your files and obtaining an Application ID. Utilizing existing Fusion Sets, this endpoint initiates the build process. After building, the `task_id` , referred to as the "Appdome Build ID," is required for all subsequent tasks related to this build.

How to Obtain the Application ID:

After successfully uploading your app to the Appdome platform, follow these steps:

  1. Navigate to the sidebar where your app is listed.
  2. The Application ID will be visible next to the app details, and you can copy it directly from there.
Key Name in Appdome Value Notes
user_agent User Agent Customization Boolean Must use with user_agent_value
user_agent_value User-Agent Header String
extended_logs Diagnostic Logs Boolean Only if enabled for the user.
- [Build an App/SDK for Testing](https://apis.appdome.com/reference/post_build-to-test-build.md): This API allows you to build and customize a mobile app or SDK with testing. After you upload your App/SDK and obtain the Application ID, you can build it for testing using an existing Fusion Set. The `fusion_set_id` is required to initiate the build (fuse) action. Upon completion of the build, a `parent_task_id` (known as the "Appdome Build ID") is generated, which is required for any subsequent task actions. This endpoint supports several customizations (overrides) for the build task, as detailed below.

How to Obtain the Application ID:

After successfully uploading your app to the Appdome platform, follow these steps:

  1. Navigate to the sidebar where your app is listed.
  2. The Application ID will be visible next to the app details, and you can copy it directly from there.
Key Name in Appdome Value Notes
user_agent User Agent Customization Boolean Must use with user_agent_value
user_agent_value User-Agent Header String
extended_logs Diagnostic Logs Boolean Only if enabled for the user.
build_to_test_vendor supported Testing Service String One of the following values:
  • AUTOMATION_AWS_DEVICE_FARM
  • AUTOMATION_BITBAR
  • AUTOMATION_BROWSERSTACK
  • AUTOMATION_LAMBDATEST
  • AUTOMATION_SAUCELABS
  • AUTOMATION_FIREBASE
  • AUTOMATION_KOBITON
  • AUTOMATION_KATALON
  • AUTOMATION_PERFECTO
  • AUTOMATION_TRICENTIS_DEVICE_CLOUD
build_to_test_message build_to_test_message String Must use with build_to_test_vendor.
- [Build a PWA](https://apis.appdome.com/reference/post_pwappload.md): This API allows you to create a PWA app from a provided URL. The PWA app can be built for either iOS (ipa), Android (aab), or both platforms. - [Get Task Status](https://apis.appdome.com/reference/get_tasks-task-id-status.md): Get status of a specific task This API Allows you to get the status of a task by ID. - [Add Context to an App](https://apis.appdome.com/reference/post_tasks-context.md): The available overrides for the Context task are:
Key Name in Appdome Value Notes
icon_overlay Add Favicon Boolean Must use with icon_overlay_scale, icon_overlay_position, icon_overlay_filename

Must also add Form data icon_overlay_s3 with an icon file (see above)

icon_overlay_scale Scale Number between 20 and 50
icon_overlay_position Favicon Position ‘Top Right’, ‘Top Left’, ‘Bottom Right’, ‘Bottom Left’
customize_url_enable Private URL Boolean Must use with customize_url_value, customize_url_key.
customize_url_value Private URL Value String
customize_url_key Private URL Identifier String
app_customization_pack_bundle_version App Version String
app_customization_pack_bundle_identifier App Bundle ID String
app_customization_pack_bundle_display_name App Display Name String
app_customization_pack_bundle_build_number App Version Code Number
app_customization_key_value_list Custom Values JSON LifeCycle, Context
- [Add Context to an App for Testing](https://apis.appdome.com/reference/post_build-to-test-context.md): The available overrides for the Context task are:
Key Name in Appdome Value Notes
icon_overlay Add Favicon Boolean Must use with icon_overlay_scale, icon_overlay_position, icon_overlay_filename

Must also add Form data icon_overlay_s3 with an icon file (see above)

icon_overlay_scale Scale Number between 20 and 50
icon_overlay_position Favicon Position ‘Top Right’, ‘Top Left’, ‘Bottom Right’, ‘Bottom Left’
customize_url_enable Private URL Boolean Must use with customize_url_value, customize_url_key.
customize_url_value Private URL Value String
customize_url_key Private URL Identifier String
app_customization_pack_bundle_version App Version String
app_customization_pack_bundle_identifier App Bundle ID String
app_customization_pack_bundle_display_name App Display Name String
app_customization_pack_bundle_build_number App Version Code Number
app_customization_key_value_list Custom Values JSON LifeCycle, Context
- [Sign an App](https://apis.appdome.com/reference/post_tasks-sign.md):

Available overrides for the Signing Task:

IOS:

Key Name in Appdome Value Notes
signing_p12_password P12 Certificate Password String
manual_entitlements_matching Manual Entitlements Matching Boolean

IOS SDK:

Key Name in Appdome Value Notes
signing_p12_password P12 Certificate Password String

Android:

Key Name in Appdome Value Notes
signing_keystore_use_google_signing Use Google Play App Signing Boolean Must use with signing_keystore_google_signing_sha1_key
signing_keystore_google_signing_sha1_key App Signing Certificate SHA-1 or SHA-256 String
signing_keystore_password Signing Keystore Password String
signing_keystore_alias Signing Keystore Alias String
signing_keystore_key_password Signing Key Password String
signing_keystore_google_signing_upgrade Google Play Upgrade Signing Key Boolean Send true if you upgraded your app signing key for new installs.
signing_keystore_google_signing_sha1_key_2nd_cert Upgraded Certificate Fingerprint String Your past key signing certificate fingerprint is required to tamper-proof built applications and allow them to run on legacy and new installs.
trusted_signing_fingerprint_list Trusted Signing Fingerprint List Array of Objects Array of trusted signing certificate fingerprints. Each object contains: SHA (string, SHA-1 or SHA-256 fingerprint), TrustedStoreSigning {optional} (boolean). Android only. Must not be used together with signing_keystore_use_google_signing, signing_keystore_google_signing_upgrade, or signing_keystore_google_signing_sha1_key_2nd_cert
- [Sign an App for Testing](https://apis.appdome.com/reference/post_build-to-test-sign.md):

Available overrides for the Signing Task:

IOS:

Key Name in Appdome Value Notes
signing_p12_password P12 Certificate Password String
manual_entitlements_matching Manual Entitlements Matching Boolean

IOS SDK:

Key Name in Appdome Value Notes
signing_p12_password P12 Certificate Password String

Android:

Key Name in Appdome Value Notes
signing_keystore_use_google_signing Use Google Play App Signing Boolean Must use with signing_keystore_google_signing_sha1_key
signing_keystore_google_signing_sha1_key App Signing Certificate SHA-1 or SHA-256 String
signing_keystore_password Signing Keystore Password String
signing_keystore_alias Signing Keystore Alias String
signing_keystore_key_password Signing Key Password String
signing_keystore_google_signing_upgrade Google Play Upgrade Signing Key Boolean Send true if you upgraded your app signing key for new installs.
signing_keystore_google_signing_sha1_key_2nd_cert Upgraded Certificate Fingerprint String Your past key signing certificate fingerprint is required to tamper-proof built applications and allow them to run on legacy and new installs.
trusted_signing_fingerprint_list Trusted Signing Fingerprint List Array of Objects Array of trusted signing certificate fingerprints. Each object contains: SHA (string, SHA-1 or SHA-256 fingerprint), TrustedStoreSigning {optional} (boolean). Android only. Must not be used together with signing_keystore_use_google_signing, signing_keystore_google_signing_upgrade, or signing_keystore_google_signing_sha1_key_2nd_cert
- [Private Sign an App](https://apis.appdome.com/reference/post_tasks-privatesign.md): Available overrides for Private Signing Task:

IOS:

Key Name in Appdome Value Notes
manual_entitlements_matching Manual Entitlements Matching Boolean

Android:

Key Name in Appdome Value Notes
signing_sha1_fingerprint certificate SHA-1 fingerprint String When signing Android apps using Private Signing or Auto-DEV Signing, please add the certificate SHA-1 fingerprint as an override
signing_keystore_use_google_signing Use Google Play App Signing Boolean Send true if you want to use different sha1 fingerprint, when true 'signing_keystore_google_signing_sha1_key' is required.
signing_keystore_google_signing_sha1_key App Signing Certificate Fingerprint String If 'signing_keystore_use_google_signing' is true, attach the string of your sha1 fingerprint.
signing_keystore_google_signing_upgrade Google Play Upgrade Signing Key Boolean Send true if you upgraded your app signing key for new installs.
signing_keystore_google_signing_sha1_key_2nd_cert Upgraded Certificate Fingerprint String Your past key signing certificate fingerprint is required to tamper-proof built applications and allow them to run on legacy and new installs.
trusted_signing_fingerprint_list Trusted Signing Fingerprint List Array of Objects Array of trusted signing certificate fingerprints. Each object contains: SHA (string, SHA-1 or SHA-256 fingerprint), TrustedStoreSigning {optional} (boolean). Android only. Must not be used together with signing_keystore_use_google_signing, signing_keystore_google_signing_upgrade, or signing_keystore_google_signing_sha1_key_2nd_cert
- [Private Sign an App for Testing](https://apis.appdome.com/reference/post_build-to-test-privatesign.md): Available overrides for Private Signing Task:

IOS:

Key Name in Appdome Value Notes
manual_entitlements_matching Manual Entitlements Matching Boolean

Android:

Key Name in Appdome Value Notes
signing_sha1_fingerprint certificate SHA-1 fingerprint String When signing Android apps using Private Signing or Auto-DEV Signing, please add the certificate SHA-1 fingerprint as an override
signing_keystore_use_google_signing Use Google Play App Signing Boolean Send true if you want to use different sha1 fingerprint, when true 'signing_keystore_google_signing_sha1_key' is required.
signing_keystore_google_signing_sha1_key App Signing Certificate Fingerprint String If 'signing_keystore_use_google_signing' is true, attach the string of your sha1 fingerprint.
signing_keystore_google_signing_upgrade Google Play Upgrade Signing Key Boolean Send true if you upgraded your app signing key for new installs.
signing_keystore_google_signing_sha1_key_2nd_cert Upgraded Certificate Fingerprint String Your past key signing certificate fingerprint is required to tamper-proof built applications and allow them to run on legacy and new installs.
trusted_signing_fingerprint_list Trusted Signing Fingerprint List Array of Objects Array of trusted signing certificate fingerprints. Each object contains: SHA (string, SHA-1 or SHA-256 fingerprint), TrustedStoreSigning {optional} (boolean). Android only. Must not be used together with signing_keystore_use_google_signing, signing_keystore_google_signing_upgrade, or signing_keystore_google_signing_sha1_key_2nd_cert
- [Auto-DEV Sign an App](https://apis.appdome.com/reference/post_tasks-autodev.md): Available overrides for Auto-DEV Signing Task:

IOS:

Key Name in Appdome Value Notes
manual_entitlements_matching Manual Entitlements Matching Boolean

Android:

Key Name in Appdome Value Notes
signing_sha1_fingerprint certificate SHA-1 fingerprint String When signing Android apps using Private Signing or Auto-DEV Signing, please add the certificate SHA-1 fingerprint as an override
signing_keystore_use_google_signing Use Google Play App Signing Boolean Send true if you want to use different sha1 fingerprint, when true 'signing_keystore_google_signing_sha1_key' is required.
signing_keystore_google_signing_sha1_key App Signing Certificate Fingerprint String If 'signing_keystore_use_google_signing' is true, attach the string of your sha1 fingerprint.
signing_keystore_google_signing_upgrade Google Play Upgrade Signing Key Boolean Send true if you upgraded your app signing key for new installs.
signing_keystore_google_signing_sha1_key_2nd_cert Upgraded Certificate Fingerprint String Your past key signing certificate fingerprint is required to tamper-proof built applications and allow them to run on legacy and new installs.
trusted_signing_fingerprint_list Trusted Signing Fingerprint List Array of Objects Array of trusted signing certificate fingerprints. Each object contains: SHA (string, SHA-1 or SHA-256 fingerprint), TrustedStoreSigning {optional} (boolean). Android only. Must not be used together with signing_keystore_use_google_signing, signing_keystore_google_signing_upgrade, or signing_keystore_google_signing_sha1_key_2nd_cert
- [Auto-DEV Sign an App for Testing](https://apis.appdome.com/reference/post_build-to-test-autodev.md): Available overrides for Auto-DEV Signing Task:

IOS:

Key Name in Appdome Value Notes
manual_entitlements_matching Manual Entitlements Matching Boolean

Android:

Key Name in Appdome Value Notes
signing_sha1_fingerprint certificate SHA-1 fingerprint String When signing Android apps using Private Signing or Auto-DEV Signing, please add the certificate SHA-1 fingerprint as an override
signing_keystore_use_google_signing Use Google Play App Signing Boolean Send true if you want to use different sha1 fingerprint, when true 'signing_keystore_google_signing_sha1_key' is required.
signing_keystore_google_signing_sha1_key App Signing Certificate Fingerprint String If 'signing_keystore_use_google_signing' is true, attach the string of your sha1 fingerprint.
signing_keystore_google_signing_upgrade Google Play Upgrade Signing Key Boolean Send true if you upgraded your app signing key for new installs.
signing_keystore_google_signing_sha1_key_2nd_cert Upgraded Certificate Fingerprint String Your past key signing certificate fingerprint is required to tamper-proof built applications and allow them to run on legacy and new installs.
trusted_signing_fingerprint_list Trusted Signing Fingerprint List Array of Objects Array of trusted signing certificate fingerprints. Each object contains: SHA (string, SHA-1 or SHA-256 fingerprint), TrustedStoreSigning {optional} (boolean). Android only. Must not be used together with signing_keystore_use_google_signing, signing_keystore_google_signing_upgrade, or signing_keystore_google_signing_sha1_key_2nd_cert
- [Download Appdome-Built App/SDK](https://apis.appdome.com/reference/get_tasks-task-id-output-buildapp.md): This API allows you to fuse a mobile App/SDK. After uploading your App/SDK and obtaining the Application ID, you can initiate the build process using an existing Fusion Set. The `fusion_set_id` is required to fuse (Build) the application. Once the build is completed, the resulting `task_id`, referred to as the "Appdome Build ID," is necessary for all subsequent task actions and is used as `parent_task_id`. This endpoint supports several overrides for customizing the build task, as detailed below. You can download an AAB file in a universal APK format. To do so, add the parameter action=sign_second_output. - [Download Obfuscation Mapping Files](https://apis.appdome.com/reference/get_tasks-task-id-output-obfuscationmapping.md): Once your App/SDK is built with obfuscation, you can download your obfuscation mapping file using the Download GET request. The Task ID is sent in the URL. - [Get App Store Deploy Script](https://apis.appdome.com/reference/get_tasks-parent-task-id-deploy-script.md): To deploy your app to Apple’s App Store, due to Apple’s requirements, you can download a script that will perform this from your Mac. This API allows you to download a script for deploying apps to the App Store. - [Upload an App/SDK Directly to Appdome](https://apis.appdome.com/reference/post_upload.md): Upload an App/SDK directly to Appdome. - [Publish Fusion Set to OTA](https://apis.appdome.com/reference/put_publish.md): Publishes fusion set certificates to the OTA (Over-The-Air) service. Only files related to that specific app identifier will be published, excluding app-specific files for other apps. - [Add/Update Users to a Company Team API](https://apis.appdome.com/reference/put_mycompany-teams-teamid-updateuserentitlements.md): Allows you to add new company users into a team or update the role and entitlements of an existing member in the team. Each API request can hold up to 50 users. - [Create a Company Team API](https://apis.appdome.com/reference/post_mycompany-teams.md): Allows you to create a new company team and add team members that belong to your company. - [Retrieve All Company Teams API](https://apis.appdome.com/reference/get_mycompany-teams.md): Allows you to retrieve your company teams accounts status, permissions, and information. - [Remove Users From a Company Team API](https://apis.appdome.com/reference/put_mycompany-teams-teamid-removeuserfromteam.md): Allows you to remove a single user from your company team. - [Retrieve a Company Team API](https://apis.appdome.com/reference/get_mycompany-teams-teamid.md): Allows you to retrieve your company team and team members information. - [Update a Company Team API](https://apis.appdome.com/reference/put_mycompany-teams-teamid.md): Allows you to update an existing company team name and description. - [Delete a Company Team API](https://apis.appdome.com/reference/delete_mycompany-teams-teamid.md): Allows you to delete a company team. This action cannot be undone. - [Block a Company User API](https://apis.appdome.com/reference/put_mycompany-users-userid-blockuser.md): Allows you to change an existing company user account status to blocked. - [Create a Company User API](https://apis.appdome.com/reference/post_mycompany-users.md): Allows you to create a new user account that belongs to your company. - [Retrieve All Company Users API](https://apis.appdome.com/reference/get_mycompany-users.md): Allows you to retrieve your company users accounts status, permissions, and information. - [Reset Company User Appdome’s Build2Secure API Token](https://apis.appdome.com/reference/post_mycompany-users-userid-refreshtoken.md): Allows you to refresh an existing company user Appdome’s Build2Secure API Token. - [Retrieve a Company User API](https://apis.appdome.com/reference/get_mycompany-users-userid.md): Allows you to retrieve your company user account status, permissions, and information. - [Update a Company User API](https://apis.appdome.com/reference/put_mycompany-users-userid.md): Allows you to update an existing company user account. - [Login and Logout Events Company Users API](https://apis.appdome.com/reference/get_mycompany-events.md): REST API for retreiving loginlogout within your company. The codes are 3000 (User Login), 3001 (Azure Login), 3004 (Okta Login), 3005 (Ping Login), 3006 (Passkey Login), 3010 (User Login Failed), 3073 (User Signed Out Manually) - [Download Secure-Certificate JSON](https://apis.appdome.com/reference/get_tasks-task-id-certificate-json.md):

You can send a GET request to download Appdome Certified Secure (JSON file) of your secured App/SDK.

- [Download Secure-Certificate PDF](https://apis.appdome.com/reference/get_tasks-task-id-certificate.md): Download Appdome’s Certified Secure certificate (PDF file) of your secured App/SDK, identified by its task ID - [Validate Certified Secure Certificate](https://apis.appdome.com/reference/post_verify-certificate.md): You can send a POST request to verify the Certified Secure certificate for the secured App/SDK using the Task ID. - [Validation Status](https://apis.appdome.com/reference/get_validation-appid-status.md): Get App Validation Status - [Validation Upload](https://apis.appdome.com/reference/post_validation-upload.md): Upload an application to validate its integrity. - [Compare](https://apis.appdome.com/reference/post_v1-devicematch-compare.md): Compares two device IDs and returns a similarity score indicating how closely they match. - [Discover](https://apis.appdome.com/reference/post_v1-devicematch-discover.md): Given a device ID and an optional similarity threshold, returns the most similar device IDs from the dataset, up to a configurable limit. ## Recipes - [Appdome Bash Flow](https://apis.appdome.com/recipes/appdome-bash-flow-1.md) - [Appdome Node.js Flow](https://apis.appdome.com/recipes/appdome-nodejs-flow.md) - [Appdome Python Flow](https://apis.appdome.com/recipes/appdome-python-flow-1.md)