App Center Client
The App Center Client API lets developers programmatically manage their App Center resources—including apps, API tokens, and organization memberships—and retrieve a wide range of analytics data such as device counts, crash reports, event metrics, audience definitions, language usage, logs, and distribution statistics.
Admin: update documentationGET
/v0.1/api_tokens
Returns api tokens for the authenticated user
POST
/v0.1/api_tokens
Creates a new User API token
GET
/v0.1/account/test/export
Lists all the endpoints available for Test accounts data
GET
/v0.1/account/test/export/accounts
Lists account data
GET
/v0.1/account/test/export/featureFlags
Lists feature flag data
GET
/v0.1/administeredOrgs
Returns a list organizations in which the requesting user is an admin
DELETE
/v0.1/api_tokens/{api_token_id}
Delete the user api_token object with the specific id
api_token_id ( path , required ) — The unique ID (UUID) of the api tokenGET
/v0.1/apps
Returns a list of apps
$orderBy ( query ) — The name of the attribute by which to order the response by. By default, apps are in order of creation. All results are ordered in ascending order.POST
/v0.1/apps
Creates a new app and returns it to the caller
DELETE
/v0.1/apps/{owner_name}/{app_name}
Delete an app
app_name ( path , required ) — The name of the applicationowner_name ( path , required ) — The name of the ownerGET
/v0.1/apps/{owner_name}/{app_name}
Return a specific app with the given app name which belongs to the given owner.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}
Partially updates a single app
app_name ( path , required ) — The name of the applicationowner_name ( path , required ) — The name of the ownerGET
/v0.1/apps/{owner_name}/{app_name}/analytics/active_device_counts
Count of active devices by interval in the time range.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsapp_build ( query ) — Application build number. If build number is specified than multiple versions are not allowed.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/audiences
Get list of audiences.
include_disabled ( query ) — Include disabled audience definitionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/analytics/audiences/definition/test
Tests audience definition.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/audiences/metadata/custom_properties
Get list of custom properties.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/audiences/metadata/device_properties
Get list of device properties.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/audiences/metadata/device_properties/{property_name}/values
Get list of device property values.
property_name ( path , required ) — Device propertycontains ( query ) — Contains stringowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/analytics/audiences/{audience_name}
Deletes audience definition.
audience_name ( path , required ) — The name of the audienceowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/audiences/{audience_name}
Gets audience definition.
audience_name ( path , required ) — The name of the audienceowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationHEAD
/v0.1/apps/{owner_name}/{app_name}/analytics/audiences/{audience_name}
Returns whether audience definition exists.
audience_name ( path , required ) — The name of the audienceowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/analytics/audiences/{audience_name}
Creates or updates audience definition.
audience_name ( path , required ) — The name of the audienceowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/user/invitations/orgs/{invitation_token}/accept
Accepts a pending organization invitation for the specified user
invitation_token ( path , required ) — The app invitation token that was sent to the userGET
/v0.1/apps/{owner_name}/{app_name}/analytics/crash_counts
Available for UWP apps only.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/analytics/crash_groups
Overall crashes and affected users count of the selected crash groups with selected versions.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/crash_groups/{crash_group_id}/crash_counts
Available for UWP apps only.
crash_group_id ( path , required ) — The id of the crash group.version ( query , required ) start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/crash_groups/{crash_group_id}/models
Available for UWP apps only.
crash_group_id ( path , required ) — The id of the crash group.version ( query , required ) $top ( query , limit ) — The maximum number of results to return. (0 will fetch all results)owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/crash_groups/{crash_group_id}/operating_systems
Available for UWP apps only.
crash_group_id ( path , required ) — The id of the crash group.version ( query , required ) $top ( query , limit ) — The maximum number of results to return. (0 will fetch all results)owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/crash_groups/{crash_group_id}/overall
Available for UWP apps only.
crash_group_id ( path , required ) — The id of the crash group.version ( query , required ) owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/crashfree_device_percentages
Percentage of crash-free device by day in the time range based on the selected versions. Api will return -1 if crash devices is greater than active devices.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.version ( query , required ) owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/analytics/distribution/release_counts
Count of total downloads for the provided distribution releases.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/analytics/event_logs/{event_name}
Delete the set of Events with the specified event names.
event_name ( path , required ) — The id of the event.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/events
Count of active events in the time range ordered by event.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsevent_name ( query ) — To select the specific events.$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results)$skip ( query , offset ) — The offset (starting at 0) of the first result to return. This parameter along with limit is used to perform pagination.$inlinecount ( query ) — Controls whether or not to include a count of all the items across all pages.$orderby ( query ) — controls the sorting order and sorting based on which columnowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/analytics/events/{event_name}
Delete the set of Events with the specified event names.
event_name ( path , required ) — The id of the event.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/events/{event_name}/count_per_device
Count of events per device by interval in the time range.
event_name ( path , required ) — The id of the event.start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/events/{event_name}/count_per_session
Count of events per session by interval in the time range.
event_name ( path , required ) — The id of the event.start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/events/{event_name}/device_count
Count of devices for an event by interval in the time range.
event_name ( path , required ) — The id of the event.start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/events/{event_name}/event_count
Count of events by interval in the time range.
event_name ( path , required ) — The id of the event.start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/events/{event_name}/properties
Event properties.
event_name ( path , required ) — The id of the event.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/events/{event_name}/properties/{event_property_name}/counts
Event properties value counts during the time range in descending order.
event_name ( path , required ) — The id of the event.event_property_name ( path , required ) — The id of the event property.start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versions$top ( query , limit ) — The number of property values to return. Set to 0 in order to fetch all results available.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/generic_log_flow
Logs received between the specified start time and the current time. The API will return a maximum of 100 logs per call.
start ( query ) — Start date time in data in ISO 8601 date time format. It must be within the current day in the UTC timezone. The default value is the start time of the current day in UTC timezone.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/languages
Languages in the time range.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results)versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/user/invitations/orgs/{invitation_token}/reject
Rejects a pending organization invitation
invitation_token ( path , required ) — The app invitation token that was sent to the userGET
/v0.1/apps/{owner_name}/{app_name}/analytics/log_flow
Logs received between the specified start time and the current time. The API will return a maximum of 100 logs per call.
start ( query ) — Start date time in data in ISO 8601 date time format. It must be within the current day in the UTC timezone. The default value is the start time of the current day in UTC timezone.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/models
Models in the time range.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results)versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/oses
OSes in the time range.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results)versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/places
Places in the time range.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results)versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/session_counts
Count of sessions in the time range.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/session_durations_distribution
Gets session duration.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/sessions_per_device
Count of sessions per device in the time range.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/analytics/versions
Count of active versions in the time range ordered by version.
start ( query , required ) — Start date time in data in ISO 8601 date time format.end ( query ) — Last date time in data in ISO 8601 date time format.$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results)versions ( query ) — To select specific application versionsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/api_tokens
Returns App API tokens for the app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/api_tokens
Creates a new App API token
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/user/metadata/optimizely
GET
/v0.1/user/notifications/emailSettings
Get Default email notification settings for the user
DELETE
/v0.1/apps/{owner_name}/{app_name}/api_tokens/{api_token_id}
Delete the App Api Token object with the specific ID
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationapi_token_id ( path , required ) — The unique ID (UUID) of the api tokenDELETE
/v0.1/apps/{owner_name}/{app_name}/apple_mapping
Delete mapping of apple app to an existing app in apple store.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/apple_mapping
Get mapping of apple app to an existing app in apple store.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/apple_mapping
Create a mapping for an existing app in apple store for the specified application.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/apple_test_flight_groups
Fetch all apple test flight groups
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/avatar
Deletes the uploaded app avatar
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/avatar
Sets the app avatar
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/azure_subscriptions
Returns a list of azure subscriptions for the app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/azure_subscriptions
Link azure subscription to an app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/azure_subscriptions/{azure_subscription_id}
Delete the azure subscriptions for the app
azure_subscription_id ( path , required ) — The unique ID (UUID) of the azure subscriptionowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/billing/aggregated
Aggregated Billing Information for owner of a given app.
service ( query ) — Type of service that should be included in the Billing Informationperiod ( query ) — Type of period that should be included in the Billing InformationshowOriginalPlans ( query ) — Controls whether the API should show the original plan when Azure Subscription is not enabledowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/branches
Returns the list of Git branches for this application
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/branches/{branch}/builds
Returns the list of builds for the branch
branch ( path , required ) — The branch nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/branches/{branch}/builds
Create a build
branch ( path , required ) — The branch nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/branches/{branch}/config
Deletes the branch build configuration
branch ( path , required ) — The branch nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/branches/{branch}/config
Gets the branch configuration
branch ( path , required ) — The branch nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/branches/{branch}/config
Configures the branch for build
branch ( path , required ) — The branch nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/branches/{branch}/config
Reconfigures the branch for build
branch ( path , required ) — The branch nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/branches/{branch}/export_config
Gets the build configuration in Azure pipeline YAML format
branch ( path , required ) — The branch nameformat ( query ) — Configuration formatowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/branches/{branch}/toolset_projects
Returns the projects in the repository for the branch, for all toolsets
branch ( path , required ) — The branch nameos ( query , required ) — The desired OS for the project scan; normally the same as the app OSplatform ( query , required ) — The desired platform for the project scanmaxSearchDepth ( query ) — The depth of the repository to search for project filesowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/bugtracker
Get bug tracker settings for a particular app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/bugtracker/crashGroup/{crash_group_id}
Get project issue related to a crash group
crash_group_id ( path , required ) — CrashGroup Idowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/build_service_status
Application specific build service status
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/builds/{build_id}
Returns the build detail for the given build ID
build_id ( path , required ) — The build IDowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/builds/{build_id}
Cancels a build
build_id ( path , required ) — The build IDowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/builds/{build_id}/distribute
Distribute a build
build_id ( path , required ) — The build IDowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/builds/{build_id}/downloads/{download_type}
Gets the download URI
build_id ( path , required ) — The build IDdownload_type ( path , required ) — The download typeowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/builds/{build_id}/logs
Get the build log
build_id ( path , required ) — The build IDowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/commits/batch
Returns commit information for a batch of shas
hashes ( query , required ) — A collection of commit SHAs comma-delimitedowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}/crashes/{crash_id}/stacktrace
Gets a stacktrace for a specific crash.
crash_group_id ( path , required ) — id of a specific groupcrash_id ( path , required ) — id of a specific crashgrouping_only ( query ) — true if the stacktrace should be only the relevant thread / exception. Default is falseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crash_groups
Gets a list of crash groups and whether the list contains all available groups.
last_occurrence_from ( query ) — Earliest date when the last time a crash occured in a crash grouplast_occurrence_to ( query ) — Latest date when the last time a crash occured in a crash groupapp_version ( query ) — versiongroup_type ( query ) group_status ( query ) group_text_search ( query ) — A freetext search that matches in crash, crash types, crash stack_traces and crash user$orderby ( query ) — the OData-like $orderby argumentcontinuation_token ( query ) — Cassandra request continuation token. The token is used for pagination.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}
Gets a specific group.
crash_group_id ( path , required ) — id of a specific groupowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}
Updates a group.
crash_group_id ( path , required ) — id of a specific groupowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}/crashes
Gets all crashes of a group.
crash_group_id ( path , required ) — id of a specific groupinclude_report ( query ) — true if the crash should include the raw crash report. Default is falseinclude_log ( query ) — true if the crash should include the custom log report. Default is falsedate_from ( query ) date_to ( query ) app_version ( query ) — versionerror_type ( query ) owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}/crashes/{crash_id}
Delete a specific crash and related attachments and blobs for an app.
crash_group_id ( path , required ) — id of a specific groupcrash_id ( path , required ) — id of a specific crashretention_delete ( query ) — true in that case if the method should skip update countsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}/crashes/{crash_id}
Gets a specific crash for an app.
crash_group_id ( path , required ) — id of a specific groupcrash_id ( path , required ) — id of a specific crashinclude_report ( query ) — true if the crash should include the raw crash report. Default is falseinclude_log ( query ) — true if the crash should include the custom log report. Default is falseinclude_details ( query ) — true if the crash should include in depth crash detailsinclude_stacktrace ( query ) — true if the crash should include the stacktrace informationgrouping_only ( query ) — true if the stacktrace should be only the relevant thread / exception. Default is falseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}/crashes/{crash_id}/native
Gets the native log of a specific crash.
crash_group_id ( path , required ) — id of a specific groupcrash_id ( path , required ) — id of a specific crashowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}/crashes/{crash_id}/native/download
Gets the native log of a specific crash as a text attachment.
crash_group_id ( path , required ) — id of a specific groupcrash_id ( path , required ) — id of a specific crashowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}/crashes/{crash_id}/raw/location
Gets the URI location to download json of a specific crash.
crash_group_id ( path , required ) — id of a specific groupcrash_id ( path , required ) — id of a specific crashowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crash_groups/{crash_group_id}/stacktrace
Gets a stacktrace for a specific crash.
crash_group_id ( path , required ) — id of a specific groupgrouping_only ( query ) — true if the stacktrace should be only the relevant thread / exception. Default is falseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crashes/{crash_id}/attachments
Gets all attachments for a specific crash.
crash_id ( path , required ) — id of a specific crashowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crashes/{crash_id}/attachments/{attachment_id}/location
Gets the URI location to download crash attachment.
crash_id ( path , required ) — id of a specific crashattachment_id ( path , required ) — attachment idowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crashes/{crash_id}/attachments/{attachment_id}/text
Gets content of the text attachment.
crash_id ( path , required ) — id of a specific crashattachment_id ( path , required ) — attachment idowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crashes/{crash_id}/session_logs
Get session logs by crash ID
crash_id ( path , required ) — The id of the a crashdate ( query ) — Date of data requestedowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/crashes_info
Gets whether the application has any crashes.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/deployments
Gets a list of CodePush deployments for the given app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/deployments
Creates a CodePush Deployment for the given app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}
Deletes a CodePush Deployment for the given app
deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}
Gets a CodePush Deployment for the given app
deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}
Modifies a CodePush Deployment for the given app
deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}/metrics
Gets all releases metrics for specified Deployment
deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}/promote_release/{promote_deployment_name}
Promote one release (default latest one) from one deployment to another
deployment_name ( path , required ) — deployment namepromote_deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}/releases
Clears a Deployment of releases
deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/users/{user_id}/devices/register
Registers a user for an existing device
user_id ( path , required ) — The ID of the userGET
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}/releases
Gets the history of releases on a Deployment
deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}/releases
Create a new CodePush release for the specified deployment
deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}/releases/{release_label}
Modifies a CodePush release metadata under the given Deployment
deployment_name ( path , required ) — deployment namerelease_label ( path , required ) — release labelowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}/rollback_release
Rollback the latest or a specific release for an app deployment
deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/deployments/{deployment_name}/uploads
Create a new CodePush release upload for the specified deployment
deployment_name ( path , required ) — deployment nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/device_configurations
Returns a list of available devices
app_upload_id ( query ) — The ID of the test runowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/device_selection
Creates a short ID for a list of devices
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/devices/block_logs
**Warning, this operation is not reversible.** A successful call to this API will permanently stop ingesting any logs received via SDK by app_id, and cannot be restored. We advise caution when using this API, it is designed to permanently disable an app_id.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/devices/block_logs/{install_id}
**Warning, this operation is not reversible.** A successful call to this API will permanently stop ingesting any logs received via SDK for the given installation ID, and cannot be restored. We advise caution when using this API, it is designed to permanently disable collection from a specific installation of the app on a device, usually following the request from a user.
install_id ( path , required ) — The id of the deviceowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/diagnostics/symbol_groups
Gets top N (ordered by crash count) of crash groups by missing symbol
top ( query , required , limit ) — top N elementsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/diagnostics/symbol_groups/{symbol_group_id}
Gets missing symbol crash group by its id
symbol_group_id ( path , required ) — missing symbol crash group idowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/diagnostics/symbol_groups_info
Gets application level statistics for all missing symbol groups
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_groups
Returns a list of distribution groups in the app specified
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/distribution_groups
Creates a new distribution group and returns it to the caller
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}
Deletes a distribution group
app_name ( path , required ) — The name of the applicationowner_name ( path , required ) — The name of the ownerdistribution_group_name ( path , required ) — The name of the distribution groupGET
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}
Returns a single distribution group for a given distribution group name
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationdistribution_group_name ( path , required ) — The name of the distribution groupPATCH
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}
Updates the attributes of distribution group
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationdistribution_group_name ( path , required ) — The name of the distribution groupGET
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}/devices
Returns all devices associated with the given distribution group
distribution_group_name ( path , required ) — The name of the distribution group.release_id ( query ) — when provided, gets the provisioning state of the devices owned by users of this distribution group when compared to the provided release.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}/devices/download_devices_list
Returns all devices associated with the given distribution group.
distribution_group_name ( path , required ) — The name of the distribution group.unprovisioned_only ( query ) — when true, filters out provisioned devicesudids ( query ) — multiple UDIDs which should be part of the resulting CSV.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}/members
Returns a list of member details in the distribution group specified
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationdistribution_group_name ( path , required ) — The name of the distribution groupexclude_pending_invitations ( query ) — Whether to exclude pending invitations in the responsePOST
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}/members
Adds the members to the specified distribution group
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationdistribution_group_name ( path , required ) — The name of the distribution groupPOST
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}/members/bulk_delete
Remove the users from the distribution group
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationdistribution_group_name ( path , required ) — The name of the distribution groupGET
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}/releases
Return basic information about distributed releases in a given distribution group.
distribution_group_name ( path , required ) — The name of the distribution group.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}/releases/{release_id}
Deletes a release with id 'release_id' in a given distribution group.
owner_name ( path , required ) — The name of the app ownerapp_name ( path , required ) — The name of the appdistribution_group_name ( path , required ) — The name of the distribution group.release_id ( path , required ) — The ID identifying the unique release.GET
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}/releases/{release_id}
Return detailed information about a distributed release in a given distribution group.
owner_name ( path , required ) — The name of the app ownerapp_name ( path , required ) — The name of the appdistribution_group_name ( path , required ) — The name of the distribution group.release_id ( path , required ) — Also supports the constant `latest`, which will return the latest release in the distribution group.is_install_page ( query ) — The check if the request is from Install pagePOST
/v0.1/apps/{owner_name}/{app_name}/distribution_groups/{distribution_group_name}/resend_invite
Resend distribution group app invite notification to previously invited testers
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationdistribution_group_name ( path , required ) — The name of the distribution groupGET
/v0.1/apps/{owner_name}/{app_name}/distribution_stores
Get all the store details from Storage store table for a particular application.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/distribution_stores
Create a new external store for the specified application.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}
delete the store based on specific store name.
store_name ( path , required ) — The name of the storeowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}
Return the store details for specified store name.
store_name ( path , required ) — The name of the storeowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}
Update the store.
store_name ( path , required ) — The name of the storeowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}/latest_release
Returns the latest release published in a store.
store_name ( path , required ) — The name of the storeowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}/releases
Return all releases published in a store
store_name ( path , required ) — The name of the storeowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}/releases/{release_id}
delete the release with release Id
store_name ( path , required ) — The name of the storerelease_id ( path , required ) — The id of the releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}/releases/{release_id}
Return releases published in a store for releaseId and storeId
store_name ( path , required ) — The name of the storerelease_id ( path , required ) — The name of the storeowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}/releases/{release_id}/publish_error_details
Return the Error Details of release which failed in publishing.
store_name ( path , required ) — The name of the storerelease_id ( path , required ) — The id of the releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}/releases/{release_id}/publish_logs
Returns publish logs for a particular release published to a particular store
store_name ( path , required ) — The name of the storerelease_id ( path , required ) — The ID of the realeaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/distribution_stores/{store_name}/releases/{release_id}/realtimestatus
Return the Real time Status publishing of release from store.
store_name ( path , required ) — The name of the storerelease_id ( path , required ) — The id of the releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/symbol_uploads
Begins the symbol upload process for a new set of symbols for the specified application
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/availableAppBuilds
List of app builds
version ( query , required ) start ( query , required ) — Start date time in data in ISO 8601 date time formatend ( query ) — Last date time in data in ISO 8601 date time format$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results till the max number.)errorType ( query ) — Type of error (handled vs unhandled), including Allowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/available_versions
Get all available versions in the time range.
start ( query , required ) — Start date time in data in ISO 8601 date time formatend ( query ) — Last date time in data in ISO 8601 date time format$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results till the max number.)$skip ( query , offset ) — The offset (starting at 0) of the first result to return. This parameter along with limit is used to perform pagination.$filter ( query ) — A filter as specified in https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering.$inlinecount ( query ) — Controls whether or not to include a count of all the items across all pages.errorType ( query ) — Type of error (handled vs unhandled), including Allowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorCountsPerDay
Count of crashes or errors by day in the time range based the selected versions. If SingleErrorTypeParameter is not provided, defaults to handlederror.
version ( query ) start ( query , required ) — Start date time in data in ISO 8601 date time formatend ( query ) — Last date time in data in ISO 8601 date time formatapp_build ( query ) — app builderrorType ( query ) — Type of error (handled vs unhandled), excluding Allowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups
List of error groups
version ( query ) app_build ( query ) — app buildgroupState ( query ) start ( query , required ) — Start date time in data in ISO 8601 date time formatend ( query ) — Last date time in data in ISO 8601 date time format$orderby ( query ) — controls the sorting order and sorting based on which column$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results till the max number.)errorType ( query ) — Type of error (handled vs unhandled), including Allowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/search
Error groups list based on search parameters
filter ( query ) — A filter as specified in OData notationq ( query ) — A query stringorder ( query ) — It controls the order of sortingsort ( query ) — It controls the sort based on specified field$top ( query , limit ) — The maximum number of results to return$skip ( query , offset ) — The offset (starting at 0) of the first result to return. This parameter along with limit is used to perform pagination.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}
Error group details
errorGroupId ( path , required ) — The id of the error groupowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}
Update error group state
errorGroupId ( path , required ) — The id of the error groupowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/operatingSystems
Top OSes of the selected error group.
errorGroupId ( path , required ) — The id of the error group$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results till the max number.)owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/errorCountsPerDay
Count of errors by day in the time range of the selected error group with selected version
errorGroupId ( path , required ) — The id of the error groupversion ( query ) start ( query , required ) — Start date time in data in ISO 8601 date time formatend ( query ) — Last date time in data in ISO 8601 date time formatowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/errorfreeDevicePercentages
Percentage of error-free devices by day in the time range. Api will return -1 if crash devices is greater than active devices
errorGroupId ( path , required ) — The id of the error groupstart ( query , required ) — Start date time in data in ISO 8601 date time formatend ( query ) — Last date time in data in ISO 8601 date time formatowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/errors
Get all errors for group
errorGroupId ( path , required ) — The id of the error groupstart ( query , required ) — Start date time in data in ISO 8601 date time formatend ( query ) — Last date time in data in ISO 8601 date time format$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results till the max number.)model ( query ) os ( query ) owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/errors/latest
Latest error details.
errorGroupId ( path , required ) — The id of the error groupowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/errors/{errorId}
Delete a specific error and related attachments and blobs for an app. Searchable data will not be deleted immediately and may take up to 30 days.
errorGroupId ( path , required ) — The id of the error grouperrorId ( path , required ) — The id of the errorowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/errors/{errorId}
Error details.
errorGroupId ( path , required ) — The id of the error grouperrorId ( path , required ) — The id of the errorowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/errors/{errorId}/download
Download details for a specific error.
errorGroupId ( path , required ) — The id of the error grouperrorId ( path , required ) — The id of the errorformat ( query ) — the format of the crash logowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/errors/{errorId}/location
Error location.
errorGroupId ( path , required ) — The id of the error grouperrorId ( path , required ) — The id of the errorowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/errors/{errorId}/stacktrace
Error Stacktrace details.
errorGroupId ( path , required ) — The id of the error grouperrorId ( path , required ) — The id of the errorowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/models
Top models of the selected error group.
errorGroupId ( path , required ) — The id of the error group$top ( query , limit ) — The maximum number of results to return. (0 will fetch all results till the max number.)owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test_runs
Returns a list of test runs
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorGroups/{errorGroupId}/stacktrace
Gets the stack trace for the error group.
errorGroupId ( path , required ) — The id of the error groupowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/errorfreeDevicePercentages
Percentage of error-free devices by day in the time range based on the selected versions. If SingleErrorTypeParameter is not provided, defaults to handlederror. API will return -1 if crash devices is greater than active devices
start ( query , required ) — Start date time in data in ISO 8601 date time formatend ( query ) — Last date time in data in ISO 8601 date time formatversions ( query ) app_build ( query ) — app builderrorType ( query ) — Type of error (handled vs unhandled), excluding Allowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/retention_settings
gets the retention settings in days
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/search
Errors list based on search parameters
filter ( query ) — A filter as specified in OData notationq ( query ) — A query stringorder ( query ) — It controls the order of sortingsort ( query ) — It controls the sort based on specified field$top ( query , limit ) — The maximum number of results to return$skip ( query , offset ) — The offset (starting at 0) of the first result to return. This parameter along with limit is used to perform pagination.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/{errorId}/attachments
List error attachments.
errorId ( path , required ) — The id of the errorowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/{errorId}/attachments/{attachmentId}/location
Error attachment location.
errorId ( path , required ) — The id of the errorattachmentId ( path , required ) — Error attachment id.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/{errorId}/attachments/{attachmentId}/text
Error attachment text.
errorId ( path , required ) — The id of the errorattachmentId ( path , required ) — Error attachment id.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/errors/{errorId}/sessionLogs
Get session logs by error ID
errorId ( path , required ) — The id of the errordate ( query ) — Date of data requestedowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/export_configurations
List export configurations.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/export_configurations
Create new export configuration
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/export_configurations/{export_configuration_id}
Delete export configuration.
export_configuration_id ( path , required ) — The id of the export configuration.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/export_configurations/{export_configuration_id}
Get export configuration.
export_configuration_id ( path , required ) — The id of the export configuration.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/test_runs
Creates a new test run
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/export_configurations/{export_configuration_id}
Partially update export configuration.
export_configuration_id ( path , required ) — The id of the export configuration.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/export_configurations/{export_configuration_id}/disable
Disable export configuration.
export_configuration_id ( path , required ) — The id of the export configuration.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/export_configurations/{export_configuration_id}/enable
Enable export configuration.
export_configuration_id ( path , required ) — The id of the export configuration.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/file_asset
Create a new asset to upload a file
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/invitations
Gets the pending invitations for the app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/invitations
Invites a new or existing user to an app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/invitations/{user_email}
Removes a user's invitation to an app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationuser_email ( path , required ) — The email of the user to invitePATCH
/v0.1/apps/{owner_name}/{app_name}/invitations/{user_email}
Update pending invitation permission
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationuser_email ( path , required ) — The email of the user to invitePOST
/v0.1/apps/{owner_name}/{app_name}/invitations/{user_email}
Invites a new or existing user to an app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationuser_email ( path , required ) — The email of the user to inviteGET
/v0.1/apps/{owner_name}/{app_name}/notifications/emailSettings
Get Email notification settings of user for a particular app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/owner/device_sets
Lists device sets belonging to the owner
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/owner/device_sets
Creates a device set belonging to the owner
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/owner/device_sets/{id}
Deletes a device set belonging to the owner
id ( path , required ) — The UUID of the device setowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/owner/device_sets/{id}
Gets a device set belonging to the owner
id ( path , required ) — The UUID of the device setowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/owner/device_sets/{id}
Updates a device set belonging to the owner
id ( path , required ) — The UUID of the device setowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/recent_releases
Get the latest release from every distribution group associated with an application.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/releases
Return basic information about releases.
published_only ( query ) — When *true*, filters out releases that were uploaded but were never distributed. Releases that under deleted distribution groups will not be filtered out.scope ( query ) — When the scope is 'tester', only includes releases that have been distributed to groups that the user belongs to.top ( query , limit ) — The number of releases to returnreleaseId ( query ) — The id of a releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/releases/filter_by_tester
Return detailed information about releases avaiable to a tester.
published_only ( query ) — when *true*, filters out releases that were uploaded but were never distributed. Releases that under deleted distribution groups will not be filtered out.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}
Deletes a release.
release_id ( path , required ) — The ID of the releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}
Get a release with id `release_id`. If `release_id` is `latest`, return the latest release that was distributed to the current user (from all the distribution groups).
release_id ( path , required ) — The ID of the release, or `latest` to get the latest release from all the distribution groups assigned to the current user.udid ( query ) — when supplied, this call will also check if the given UDID is provisioned. Will be ignored for non-iOS platforms. The value will be returned in the property is_udid_provisioned.is_install_page ( query ) — The check if the request is from Install pageowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}
Updates a release.
release_id ( path , required ) — The ID of the releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}
Update details of a release.
release_id ( path , required ) — The ID of the releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/groups
Distributes a release to a group
release_id ( path , required ) — The ID of the releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/groups/{group_id}
Delete the given distribution group from the release
release_id ( path , required ) — The ID of the releasegroup_id ( path , required ) — The id of the distribution groupowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/groups/{group_id}
Update details about the specified distribution group associated with the release
release_id ( path , required ) — The ID of the releasegroup_id ( path , required ) — The id of the releases destinationowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/provisioning_profile
Return information about the provisioning profile. Only available for iOS.
release_id ( path , required ) — The release_idowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/stores
Distributes a release to a store
release_id ( path , required ) — The ID of the releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/stores/{store_id}
Delete the given distribution store from the release
release_id ( path , required ) — The ID of the releasestore_id ( path , required ) — The id of the distribution storeowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/testers
Distributes a release to a user
release_id ( path , required ) — The ID of the releaseowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/testers/{tester_id}
Delete the given tester from the release
release_id ( path , required ) — The ID of the releasetester_id ( path , required ) — The id of the testerowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/testers/{tester_id}
Update details about the specified tester associated with the release
release_id ( path , required ) — The ID of the releasetester_id ( path , required ) — The id of the testerowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}/update_devices/{resign_id}
Returns the resign status to the caller
release_id ( path , required ) — The ID of the release.resign_id ( path , required ) — The ID of the resign operation.include_provisioning_profile ( query ) — A boolean value that indicates if the provisioning profile should be return in addition to the status. When set to true, the provisioning profile will be returned only when status is 'complete' or 'preparing_for_testers'.owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/repo_config
Removes the configuration for the repository
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/repo_config
Returns the repository build configuration status of the app
includeInactive ( query ) — Include inactive configurations if none are activeowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/repo_config
Configures the repository for build
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/source_hosts/{source_host}/repositories
Gets the repositories available from the source code host
source_host ( path , required ) — The source hostvstsAccountName ( query ) — Filter repositories only for specified account and project, "vstsProjectId" is requiredvstsProjectId ( query ) — Filter repositories only for specified account and project, "vstsAccountName" is requiredservice_connection_id ( query ) — The id of the service connection (private). Required for GitLab self-hosted repositoriesform ( query ) — The selected form of the objectowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/store_service_status
Application specific store service status
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/subscriptions
Get information about the currently active subscriptions, if any
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/subscriptions
Accept a free trial subscription
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/symbol_uploads
Gets a list of all uploads for the specified application
top ( query , limit ) — The maximum number of results to return.status ( query ) — Filter results by the current status of a symbol upload: * all: all states in the symbol upload process. Includes created, aborted, committed, processing, indexed and failed states * uploaded: all states after package is uploaded. Includes committed, processing, indexed and failed states * processed: symbol upload processing is completed. Includes indexed and failed states.symbol_type ( query ) — The type of symbolsowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/orgs/{org_name}/teams
Creates a team and returns it
org_name ( path , required ) — The organization's nameDELETE
/v0.1/apps/{owner_name}/{app_name}/symbol_uploads/{symbol_upload_id}
Deletes a symbol upload by id for the specified application
symbol_upload_id ( path , required ) — The ID of the symbol uploadowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/symbol_uploads/{symbol_upload_id}
Gets a symbol upload by id for the specified application
symbol_upload_id ( path , required ) — The ID of the symbol uploadowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/symbol_uploads/{symbol_upload_id}
Commits or aborts the symbol upload process for a new set of symbols for the specified application
symbol_upload_id ( path , required ) — The ID of the symbol uploadowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/symbol_uploads/{symbol_upload_id}/location
Gets the URL to download the symbol upload
symbol_upload_id ( path , required ) — The ID of the symbol uploadowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/symbols
Returns the list of all symbols for the provided application
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/symbols/{symbol_id}
Returns a particular symbol by id (uuid) for the provided application
symbol_id ( path , required ) — The ID of the symbol (uuid of the symbol)owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/symbols/{symbol_id}/ignore
Marks a symbol by id (uuid) as ignored
symbol_id ( path , required ) — The ID of the symbol (uuid of the symbol)owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/symbols/{symbol_id}/location
Gets the URL to download the symbol
symbol_id ( path , required ) — The ID of the symbol (uuid of the symbol)owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/symbols/{symbol_id}/status
Returns a particular symbol by id (uuid) for the provided application
symbol_id ( path , required ) — The ID of the symbol (uuid of the symbol)owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/teams
Returns the details of all teams that have access to the app.
app_name ( path , required ) — The name of the applicationowner_name ( path , required ) — The name of the ownerGET
/v0.1/apps/{owner_name}/{app_name}/test/export
Lists all the endpoints available for Test apps data
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test/export/apps
Lists app data
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test/export/fileSetFiles
Lists file set file data
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test/export/hashFiles
Lists hash file data
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test/export/pipelineTests
Lists pipeline test data
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test/export/testRuns
Lists test run data
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/test_runs/{test_run_id}
Logically deletes a test run
test_run_id ( path , required ) — The ID of the test runowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test_runs/{test_run_id}
Returns a single test runs
test_run_id ( path , required ) — The ID of the test runowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/test_runs/{test_run_id}/files
Uploads file for a test run
test_run_id ( path , required ) — The ID of the test runowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/test_runs/{test_run_id}/hashes
Adds file with the given hash to a test run
test_run_id ( path , required ) — The ID of the test runowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/test_runs/{test_run_id}/hashes/batch
Adds file with the given hash to a test run
test_run_id ( path , required ) — The ID of the test runowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test_runs/{test_run_id}/report
Returns a single test report
test_run_id ( path , required ) — The ID of the test runowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/test_runs/{test_run_id}/start
Starts test run
test_run_id ( path , required ) — The ID of the test runowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test_runs/{test_run_id}/state
Gets state of the test run
test_run_id ( path , required ) — The ID of the test runowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/test_runs/{test_run_id}/stop
Stop a test run execution
test_run_id ( path , required ) — The ID of the test run to be stoppedowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test_series
Returns list of all test series for an application
query ( query ) — A query string to filter test seriesowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/test_series
Creates new test series for an application
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/test_series/{test_series_slug}
Deletes a single test series
test_series_slug ( path , required ) — The slug of the test seriesowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/test_series/{test_series_slug}
Updates name and slug of a test series
test_series_slug ( path , required ) — The slug of the test seriesowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/test_series/{test_series_slug}/test_runs
Returns list of all test runs for a given test series
test_series_slug ( path , required ) — The slug of the test seriesowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/testers
Returns the testers associated with the app specified with the given app name which belongs to the given owner.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/testers/{tester_id}
Delete the given tester from the all releases
tester_id ( path , required ) — The id of the testerowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/toolsets
Returns available toolsets for application
tools ( query ) — Toolset nameowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/transfer/{destination_owner_name}
Transfers ownership of an app to a different user or organization
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationdestination_owner_name ( path , required ) — The name of the owner (user or organization) to which the app is being transferredPOST
/v0.1/apps/{owner_name}/{app_name}/transfer_to_org
Transfers ownership of an app to a new organization
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/uploads/releases
Initiate a new release upload. This API is part of multi-step upload process.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/uploads/releases/{upload_id}
Get the current status of the release upload.
upload_id ( path , required ) — The ID of the release uploadowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/apps/{owner_name}/{app_name}/uploads/releases/{upload_id}
Update the current status of the release upload.
upload_id ( path , required ) — The ID of the release uploadextract ( query ) — A flag that indicates to extract release or not, true by defaultowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/user/device_sets
Lists device sets belonging to the user
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPOST
/v0.1/apps/{owner_name}/{app_name}/user/device_sets
Creates a device set belonging to the user
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/user/device_sets/{id}
Deletes a device set belonging to the user
id ( path , required ) — The UUID of the device setowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/user/device_sets/{id}
Gets a device set belonging to the user
id ( path , required ) — The UUID of the device setowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationPUT
/v0.1/apps/{owner_name}/{app_name}/user/device_sets/{id}
Updates a device set belonging to the user
id ( path , required ) — The UUID of the device setowner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/users
Returns the users associated with the app specified with the given app name which belongs to the given owner.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationDELETE
/v0.1/apps/{owner_name}/{app_name}/users/{user_email}
Removes the user from the app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationuser_email ( path , required ) — The user email of the user to deletePATCH
/v0.1/apps/{owner_name}/{app_name}/users/{user_email}
Update user permission for the app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationuser_email ( path , required ) — The user email of the user to patchGET
/v0.1/apps/{owner_name}/{app_name}/versions
Gets a list of application versions.
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/webhooks
Get web hooks configured for a particular app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/xamarin_sdk_bundles
Gets the Xamarin SDK bundles available to this app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/apps/{owner_name}/{app_name}/xcode_versions
Gets the Xcode versions available to this app
owner_name ( path , required ) — The name of the ownerapp_name ( path , required ) — The name of the applicationGET
/v0.1/azure_subscriptions
Returns a list of azure subscriptions for the user
GET
/v0.1/billing/allAccountsAggregated
Aggregated Billing Information for the requesting user and the organizations in which the user is an admin.
service ( query ) — Type of service that should be included in the Billing Informationperiod ( query ) — Type of period that should be included in the Billing InformationshowOriginalPlans ( query ) — Controls whether the API should show the original plan when Azure Subscription is not enabledGET
/v0.1/invitations/sent
Returns all invitations sent by the caller
POST
/v0.1/legacy/reportStatus/deploy
Report deploy of specified release
POST
/v0.1/legacy/reportStatus/download
Report download of specified release
GET
/v0.1/legacy/updateCheck
Check for updates
deploymentKey ( query ) appVersion ( query ) packageHash ( query ) label ( query ) clientUniqueId ( query ) isCompanion ( query ) GET
/v0.1/orgs
Returns a list of organizations the requesting user has access to
POST
/v0.1/orgs
Creates a new organization and returns it to the caller
GET
/v0.1/orgs/{orgName}/billing/aggregated
Aggregated Billing Information for a given Organization.
orgName ( path , required ) — The name of the Organizationservice ( query ) — Type of service that should be included in the Billing Informationperiod ( query ) — Type of period that should be included in the Billing InformationshowOriginalPlans ( query ) — Controls whether the API should show the original plan when Azure Subscription is not enabledDELETE
/v0.1/orgs/{org_name}
Deletes a single organization
org_name ( path , required ) — The organization's nameGET
/v0.1/orgs/{org_name}
Returns the details of a single organization
org_name ( path , required ) — The organization's namePATCH
/v0.1/orgs/{org_name}
Returns a list of organizations the requesting user has access to
org_name ( path , required ) — The organization's nameGET
/v0.1/orgs/{org_name}/apps
Returns a list of apps for the organization
org_name ( path , required ) — The organization's namePOST
/v0.1/orgs/{org_name}/apps
Creates a new app for the organization and returns it to the caller
org_name ( path , required ) — The organization's nameDELETE
/v0.1/orgs/{org_name}/avatar
Deletes the uploaded organization avatar
org_name ( path , required ) — The organization's namePOST
/v0.1/orgs/{org_name}/avatar
Sets the organization avatar
org_name ( path , required ) — The organization's nameGET
/v0.1/orgs/{org_name}/azure_subscriptions
Returns a list of azure subscriptions for the organization
org_name ( path , required ) — The organization's nameGET
/v0.1/orgs/{org_name}/distribution_groups
Returns a list of distribution groups in the org specified
org_name ( path , required ) — The organization's namePOST
/v0.1/orgs/{org_name}/distribution_groups
Creates a disribution goup which can be shared across apps under an organization
org_name ( path , required ) — The organization's nameDELETE
/v0.1/orgs/{org_name}/teams/{team_name}
Deletes a single team
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's nameDELETE
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}
Deletes a single distribution group from an org with a given distribution group name
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupGET
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}
Returns a single distribution group in org for a given distribution group name
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupPATCH
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}
Update one given distribution group name in an org
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupGET
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}/apps
Get apps from a distribution group in an org
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupPOST
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}/apps
Add apps to distribution group in an org
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupPOST
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}/apps/bulk_delete
Delete apps from distribution group in an org
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupGET
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}/members
Returns a list of member in the distribution group specified
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupPOST
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}/members
Accepts an array of user email addresses to get added to the specified group
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupPOST
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}/members/bulk_delete
Delete testers from distribution group in an org
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupPOST
/v0.1/orgs/{org_name}/distribution_groups/{distribution_group_name}/resend_invite
Resend shared distribution group invite notification to previously invited testers
org_name ( path , required ) — The organization's namedistribution_group_name ( path , required ) — The name of the distribution groupGET
/v0.1/orgs/{org_name}/distribution_groups_details
Returns a list of distribution groups with details for an organization
org_name ( path , required ) — The organization's nameapps_limit ( query ) — The max number of apps to include in the responseDELETE
/v0.1/orgs/{org_name}/invitations
Removes a user's invitation to an organization
org_name ( path , required ) — The organization's nameGET
/v0.1/orgs/{org_name}/invitations
Gets the pending invitations for the organization
org_name ( path , required ) — The organization's namePOST
/v0.1/orgs/{org_name}/invitations
Invites a new or existing user to an organization
org_name ( path , required ) — The organization's namePATCH
/v0.1/orgs/{org_name}/invitations/{email}
Allows the role of an invited user to be changed
org_name ( path , required ) — The organization's nameemail ( path , required ) — The email address of the user to send the password reset mail to.POST
/v0.1/orgs/{org_name}/invitations/{email}/resend
Cancels an existing organization invitation for the user and sends a new one
org_name ( path , required ) — The organization's nameemail ( path , required ) — The email address of the user to send the password reset mail to.POST
/v0.1/orgs/{org_name}/invitations/{email}/revoke
Removes a user's invitation to an organization
org_name ( path , required ) — The organization's nameemail ( path , required ) — The email address of the user to send the password reset mail to.GET
/v0.1/orgs/{org_name}/teams
Returns the list of all teams in this org
org_name ( path , required ) — The organization's nameGET
/v0.1/orgs/{org_name}/teams/{team_name}
Returns the details of a single team
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's namePATCH
/v0.1/orgs/{org_name}/teams/{team_name}
Updates a single team
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's nameGET
/v0.1/orgs/{org_name}/teams/{team_name}/apps
Returns the apps a team has access to
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's namePOST
/v0.1/orgs/{org_name}/teams/{team_name}/apps
Adds an app to a team
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's nameDELETE
/v0.1/orgs/{org_name}/teams/{team_name}/apps/{app_name}
Removes an app from a team
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's nameapp_name ( path , required ) — The name of the applicationPATCH
/v0.1/orgs/{org_name}/teams/{team_name}/apps/{app_name}
Updates the permissions the team has to the app
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's nameapp_name ( path , required ) — The name of the applicationGET
/v0.1/orgs/{org_name}/teams/{team_name}/users
Returns the users of a team which is owned by an organization
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's namePOST
/v0.1/orgs/{org_name}/teams/{team_name}/users
Adds a new user to a team that is owned by an organization
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's nameDELETE
/v0.1/orgs/{org_name}/teams/{team_name}/users/{user_name}
Removes a user from a team that is owned by an organization
org_name ( path , required ) — The organization's nameteam_name ( path , required ) — The team's nameuser_name ( path , required ) — The slug name of the userGET
/v0.1/orgs/{org_name}/testers
Returns a unique list of users including the whole organization members plus testers in any shared group of that org
org_name ( path , required ) — The organization's nameGET
/v0.1/orgs/{org_name}/users
Returns a list of users that belong to an organization
org_name ( path , required ) — The organization's nameDELETE
/v0.1/orgs/{org_name}/users/{user_name}
Removes a user from an organization.
org_name ( path , required ) — The organization's nameuser_name ( path , required ) — The slug name of the userGET
/v0.1/orgs/{org_name}/users/{user_name}
Get a user information from an organization by name - if there is explicit permission return it, if not if not return highest implicit permission
org_name ( path , required ) — The organization's nameuser_name ( path , required ) — The slug name of the userPATCH
/v0.1/orgs/{org_name}/users/{user_name}
Updates the given organization user
org_name ( path , required ) — The organization's nameuser_name ( path , required ) — The slug name of the userGET
/v0.1/orgs/{org_name}/users/{user_name}/apps
Get a user apps information from an organization by name
org_name ( path , required ) — The organization's nameuser_name ( path , required ) — The slug name of the userGET
/v0.1/public/apps/{app_id}/releases/{release_id}/ios_manifest
Returns the manifest.plist in XML format for installing the release on a device. Only available for iOS.
app_id ( path , required ) — The ID of the applicationrelease_id ( path , required ) — The release_idtoken ( query , required ) — A hash that authorizes the download if it matches the release info.POST
/v0.1/public/apps/{owner_name}/{app_name}/install_analytics
Notify download(s) for the provided distribution release(s).
owner_name ( path , required ) — The name of the app ownerapp_name ( path , required ) — The name of the appPOST
/v0.1/public/codepush/report_status/deploy
Report Deployment status metric
POST
/v0.1/public/codepush/report_status/download
Report download of specified release
GET
/v0.1/public/codepush/status
Returns the acquisition service status to the caller
GET
/v0.1/public/codepush/update_check
Check for updates
deployment_key ( query , required ) app_version ( query , required ) package_hash ( query ) label ( query ) client_unique_id ( query ) is_companion ( query ) previous_label_or_app_version ( query ) previous_deployment_key ( query ) POST
/v0.1/public/hooks
Public webhook sink
GET
/v0.1/public/sdk/apps/{app_secret}/distribution_groups/{distribution_group_id}/releases/latest
Get a release with 'latest' for the given public group.
app_secret ( path , required ) — The secret of the target applicationdistribution_group_id ( path , required ) — the id for destinationis_install_page ( query ) — The check if the request is from Install pageGET
/v0.1/public/sdk/apps/{app_secret}/releases/latest
Get the latest public release for the given app.
app_secret ( path , required ) — The secret of the target applicationGET
/v0.1/public/sdk/apps/{app_secret}/releases/{release_hash}/public_distribution_groups
Get all public distribution groups that a given release has been distributed to
app_secret ( path , required ) — The secret of the target applicationrelease_hash ( path , required ) — The hash of the releaseGET
/v0.1/public/sparkle/apps/{app_secret}
Gets the sparkle feed of the releases that are distributed to all the public distribution groups.
app_secret ( path , required ) — The secret of the application.GET
/v0.1/sdk/apps/{app_secret}/releases/private/latest
Get the latest release distributed to a private group the given user is a member of for the given app.
app_secret ( path , required ) — The secret of the target applicationudid ( query ) — When passing `udid` in the query string, a provisioning check for the given device ID will be done. Will be ignored for non-iOS platforms.GET
/v0.1/sdk/apps/{app_secret}/releases/{release_hash}
If 'latest' is not specified then it will return the specified release if it's enabled. If 'latest' is specified, regardless of whether a release hash is provided, the latest enabled release is returned.
app_secret ( path , required ) — The secret of the target applicationrelease_hash ( path , required ) — The hash of the release or 'latest' to get the latest release from all the distribution groups assigned to the current user.udid ( query ) — When passing `udid` in the query string, a provisioning check for the given device ID will be done. Will be ignored for non-iOS platforms.GET
/v0.1/user
Returns the user profile data
PATCH
/v0.1/user
Updates the user profile and returns the updated user data
GET
/v0.1/user/devices
Returns all devices associated with the given user.
DELETE
/v0.1/user/devices/{device_udid}
Removes an existing device from a user
device_udid ( path , required ) — The UDID of the deviceGET
/v0.1/user/devices/{device_udid}
Returns the device details.
device_udid ( path , required ) — The UDID of the deviceGET
/v0.1/user/dsr/delete/{token}
token ( path , required ) — Unique request ID (GUID)email ( query , required ) — Email used for delete with x-authz-bypass headersPOST
/v0.1/user/dsr/delete/{token}/cancel
token ( path , required ) — Unique request ID (GUID)GET
/v0.1/user/dsr/export/{token}
token ( path , required ) — Unique request ID (GUID)POST
/v0.1/user/dsr/export/{token}/cancel
token ( path , required ) — Unique request ID (GUID)GET
/v0.1/user/export/serviceConnections
Gets all service connections of the service type for GDPR export.
POST
/v0.1/user/invitations/apps/{invitation_token}/accept
Accepts a pending invitation for the specified user
invitation_token ( path , required ) — The app invitation token that was sent to the userPOST
/v0.1/user/invitations/apps/{invitation_token}/reject
Rejects a pending invitation for the specified user
invitation_token ( path , required ) — The app invitation token that was sent to the userPOST
/v0.1/user/invitations/distribution_groups/accept
Accepts all pending invitations to distribution groups for the specified user
352 endpoints auto-detected
Authentication
This API uses an API key, passed in the "X-API-Token" header. No OAuth required.
curl -X GET \
"https://api.appcenter.ms/v0.1/api_tokens" \
-H "X-API-Token: YOUR_API_KEY" api.appcenter.ms · HTTPS only