Open documentation ↗Overview
<p>Welcome to the AWS Device Farm API documentation, which contains APIs for:</p> <ul> <li> <p>Testing on desktop browsers</p> <p> Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain <code>TestGrid</code> in their names. For more information, see <a href="https://docs.aws.amazon.com/devicefarm/latest/testgrid/">Testing Web Applications on Selenium with Device Farm</a>.</p> </li> <li> <p>Testing on real mobile devices</p> <p>Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/">Device Farm Developer Guide</a>.</p> </li> </ul>
AWS Device Farm is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 77 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2015-06-23
- Endpoints
- 77
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-11
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=DeviceFarm_20150623.CreateDevicePool | Creates a device pool. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.CreateInstanceProfile | Creates a profile that can be applied to one or more private fleet device instances. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.CreateNetworkProfile | Creates a network profile. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.CreateProject | Creates a project. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.CreateRemoteAccessSession | Specifies and starts a remote access session. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.CreateTestGridProject | Creates a Selenium testing project. Projects are used to track <a>TestGridSession</a> instances. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.CreateTestGridUrl | Creates a signed, short-term URL that can be passed to a Selenium <code>RemoteWebDriver</code> constructor. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.CreateUpload | Uploads an app or test scripts. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.CreateVPCEConfiguration | Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.DeleteDevicePool | Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.DeleteInstanceProfile | Deletes a profile that can be applied to one or more private device instances. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.DeleteNetworkProfile | Deletes a network profile. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.DeleteProject | <p>Deletes an AWS Device Farm project, given the project ARN.</p> <p> Deleting this resource does not stop an in-progress run.</p> |
| POST | /#X-Amz-Target=DeviceFarm_20150623.DeleteRemoteAccessSession | Deletes a completed remote access session and its results. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.DeleteRun | <p>Deletes the run, given the run ARN.</p> <p> Deleting this resource does not stop an in-progress run.</p> |
| POST | /#X-Amz-Target=DeviceFarm_20150623.DeleteTestGridProject | <p> Deletes a Selenium testing project and all content generated under it. </p> <important> <p>You cannot undo this operation.</p> </important> <note> <p>You ca |
| POST | /#X-Amz-Target=DeviceFarm_20150623.DeleteUpload | Deletes an upload given the upload ARN. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.DeleteVPCEConfiguration | Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetAccountSettings | Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetDevice | Gets information about a unique device type. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetDeviceInstance | Returns information about a device instance that belongs to a private device fleet. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetDevicePool | Gets information about a device pool. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetDevicePoolCompatibility | Gets information about compatibility with a device pool. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetInstanceProfile | Returns information about the specified instance profile. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetJob | Gets information about a job. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetNetworkProfile | Returns information about a network profile. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetOfferingStatus | Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and th |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetProject | Gets information about a project. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetRemoteAccessSession | Returns a link to a currently running remote access session. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetRun | Gets information about a run. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetSuite | Gets information about a suite. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetTest | Gets information about a test. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetTestGridProject | Retrieves information about a Selenium testing project. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetTestGridSession | <p>A session is an instance of a browser created through a <code>RemoteWebDriver</code> with the URL from <a>CreateTestGridUrlResult$url</a>. You can use the fo |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetUpload | Gets information about an upload. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.GetVPCEConfiguration | Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.InstallToRemoteAccessSession | Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListArtifacts | Gets information about artifacts. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListDeviceInstances | Returns information about the private device instances associated with one or more AWS accounts. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListDevicePools | Gets information about device pools. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListDevices | Gets information about unique device types. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListInstanceProfiles | Returns information about all the instance profiles in an AWS account. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListJobs | Gets information about jobs for a given test run. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListNetworkProfiles | Returns the list of available network profiles. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListOfferingPromotions | Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a <code>NotEligible</cod |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListOfferingTransactions | Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending time |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListOfferings | Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListProjects | Gets information about projects. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListRemoteAccessSessions | Returns a list of all currently running remote access sessions. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListRuns | Gets information about runs, given an AWS Device Farm project ARN. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListSamples | Gets information about samples, given an AWS Device Farm job ARN. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListSuites | Gets information about test suites for a given job. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListTagsForResource | List the tags for an AWS Device Farm resource. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListTestGridProjects | Gets a list of all Selenium testing projects in your account. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListTestGridSessionActions | Returns a list of the actions taken in a <a>TestGridSession</a>. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListTestGridSessionArtifacts | Retrieves a list of artifacts created during the session. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListTestGridSessions | Retrieves a list of sessions for a <a>TestGridProject</a>. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListTests | Gets information about tests in a given test suite. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListUniqueProblems | <p>Gets information about unique problems, such as exceptions or crashes.</p> <p>Unique problems are defined as a single instance of an error across a run, job, |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListUploads | Gets information about uploads, given an AWS Device Farm project ARN. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ListVPCEConfigurations | Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.PurchaseOffering | Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.RenewOffering | Explicitly sets the quantity of devices to renew for an offering, starting from the <code>effectiveDate</code> of the next period. The API returns a <code>NotEl |
| POST | /#X-Amz-Target=DeviceFarm_20150623.ScheduleRun | Schedules a run. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.StopJob | Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this |
| POST | /#X-Amz-Target=DeviceFarm_20150623.StopRemoteAccessSession | Ends a specified remote access session. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.StopRun | Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for the |
| POST | /#X-Amz-Target=DeviceFarm_20150623.TagResource | Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request paramet |
| POST | /#X-Amz-Target=DeviceFarm_20150623.UntagResource | Deletes the specified tags from a resource. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.UpdateDeviceInstance | Updates information about a private device instance. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.UpdateDevicePool | Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be upda |
| POST | /#X-Amz-Target=DeviceFarm_20150623.UpdateInstanceProfile | Updates information about an existing private device instance profile. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.UpdateNetworkProfile | Updates the network profile. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.UpdateProject | Modifies the specified project name, given the project ARN and a new name. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.UpdateTestGridProject | Change details of a project. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.UpdateUpload | Updates an uploaded test spec. |
| POST | /#X-Amz-Target=DeviceFarm_20150623.UpdateVPCEConfiguration | Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration. |
Questions
Does the AWS Device Farm API need an API key?
Yes. The AWS Device Farm API uses API key authentication; the documentation explains how to get credentials.
Does the AWS Device Farm API support HTTPS?
Yes, the AWS Device Farm API is served over HTTPS.
How many endpoints does the AWS Device Farm API have?
Its OpenAPI description lists 77 endpoints in version 2015-06-23. All of them are shown on this page.
What are alternatives to the AWS Device Farm API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).