Open documentation ↗Overview
<p>Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand. </p> <p> <b>About Amazon GameLift solutions</b> </p> <p>Get more information on these Amazon GameLift solutions in the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/">Amazon GameLift Developer Guide</a>.</p> <ul> <li> <p>Amazon GameLift managed hosting -- Amazon GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.</p> </li> <li> <p>Managed hosting with Realtime Servers -- With Amazon GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core Amazon GameLift infrastructure already built in. Then use the full range of Amazon GameLift managed hosting features, including FlexMatch, for your game.</p> </li> <li> <p>Amazon GameLift FleetIQ -- Use Amazon GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. Amazon GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the Amazon GameLift FleetIQ and FlexMatch standalone services.</p> </li> <li> <p>Amazon GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with Amazon GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.</p> </li> </ul> <p> <b>About this API Reference</b> </p> <p>This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html">Amazon GameLift API operations listed by tasks</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html"> Amazon GameLift tools and resources</a> </p> </li> </ul>
Amazon GameLift is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 104 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2015-10-01
- Endpoints
- 104
- OpenAPI
- Specification ↗
- Spec updated
- 2020-04-02
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=GameLift.AcceptMatch | <p>Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches bu |
| POST | /#X-Amz-Target=GameLift.ClaimGameServer | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Locates an available game server and temporarily res |
| POST | /#X-Amz-Target=GameLift.CreateAlias | <p>Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that i |
| POST | /#X-Amz-Target=GameLift.CreateBuild | <p>Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift. </ |
| POST | /#X-Amz-Target=GameLift.CreateFleet | <p>Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your custom game server or Realtime Servers. Use this operation to configure t |
| POST | /#X-Amz-Target=GameLift.CreateFleetLocations | <p>Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-sca |
| POST | /#X-Amz-Target=GameLift.CreateGameServerGroup | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Creates a Amazon GameLift FleetIQ game server group |
| POST | /#X-Amz-Target=GameLift.CreateGameSession | <p>Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and r |
| POST | /#X-Amz-Target=GameLift.CreateGameSessionQueue | <p>Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find a |
| POST | /#X-Amz-Target=GameLift.CreateLocation | Creates a custom location for use in an Anywhere fleet. |
| POST | /#X-Amz-Target=GameLift.CreateMatchmakingConfiguration | <p>Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking |
| POST | /#X-Amz-Target=GameLift.CreateMatchmakingRuleSet | <p>Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the pa |
| POST | /#X-Amz-Target=GameLift.CreatePlayerSession | <p>Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in <code>ACTIVE |
| POST | /#X-Amz-Target=GameLift.CreatePlayerSessions | <p>Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in <code>ACTIV |
| POST | /#X-Amz-Target=GameLift.CreateScript | <p>Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game lo |
| POST | /#X-Amz-Target=GameLift.CreateVpcPeeringAuthorization | <p>Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon |
| POST | /#X-Amz-Target=GameLift.CreateVpcPeeringConnection | <p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC |
| POST | /#X-Amz-Target=GameLift.DeleteAlias | <p>Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error |
| POST | /#X-Amz-Target=GameLift.DeleteBuild | <p>Deletes a build. This operation permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any activ |
| POST | /#X-Amz-Target=GameLift.DeleteFleet | <p>Deletes all resources and information related a fleet. Any current fleet instances, including those in remote locations, are shut down. You don't need to cal |
| POST | /#X-Amz-Target=GameLift.DeleteFleetLocations | <p>Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are |
| POST | /#X-Amz-Target=GameLift.DeleteGameServerGroup | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Terminates a game server group and permanently delet |
| POST | /#X-Amz-Target=GameLift.DeleteGameSessionQueue | Deletes a game session queue. Once a queue is successfully deleted, unfulfilled <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameS |
| POST | /#X-Amz-Target=GameLift.DeleteLocation | <p>Deletes a custom location.</p> <p>Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it |
| POST | /#X-Amz-Target=GameLift.DeleteMatchmakingConfiguration | Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is bei |
| POST | /#X-Amz-Target=GameLift.DeleteMatchmakingRuleSet | <p>Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by |
| POST | /#X-Amz-Target=GameLift.DeleteScalingPolicy | <p>Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift removes all record of it. To delete a scaling policy, spec |
| POST | /#X-Amz-Target=GameLift.DeleteScript | <p>Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 |
| POST | /#X-Amz-Target=GameLift.DeleteVpcPeeringAuthorization | <p>Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use <a href="https://docs.aws.am |
| POST | /#X-Amz-Target=GameLift.DeleteVpcPeeringConnection | <p>Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete.. </p> |
| POST | /#X-Amz-Target=GameLift.DeregisterCompute | Removes a compute resource from the specified fleet. Deregister your compute resources before you delete the compute. |
| POST | /#X-Amz-Target=GameLift.DeregisterGameServer | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Removes the game server from a game server group. As |
| POST | /#X-Amz-Target=GameLift.DescribeAlias | <p>Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use <code>ResolveAlias</co |
| POST | /#X-Amz-Target=GameLift.DescribeBuild | <p>Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is re |
| POST | /#X-Amz-Target=GameLift.DescribeCompute | Retrieves properties for a compute resource. To request a compute resource specify the fleet ID and compute name. If successful, Amazon GameLift returns an obje |
| POST | /#X-Amz-Target=GameLift.DescribeEC2InstanceLimits | <p>Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per ins |
| POST | /#X-Amz-Target=GameLift.DescribeFleetAttributes | <p>Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.</p> <p>This operation can |
| POST | /#X-Amz-Target=GameLift.DescribeFleetCapacity | <p>Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and setting |
| POST | /#X-Amz-Target=GameLift.DescribeFleetEvents | <p>Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capaci |
| POST | /#X-Amz-Target=GameLift.DescribeFleetLocationAttributes | <p>Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity. </p> <p>This operation can be used in the |
| POST | /#X-Amz-Target=GameLift.DescribeFleetLocationCapacity | <p>Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling set |
| POST | /#X-Amz-Target=GameLift.DescribeFleetLocationUtilization | <p>Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this |
| POST | /#X-Amz-Target=GameLift.DescribeFleetPortSettings | <p>Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use |
| POST | /#X-Amz-Target=GameLift.DescribeFleetUtilization | <p>Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. |
| POST | /#X-Amz-Target=GameLift.DescribeGameServer | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Retrieves information for a registered game server. |
| POST | /#X-Amz-Target=GameLift.DescribeGameServerGroup | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Retrieves information on a game server group. This o |
| POST | /#X-Amz-Target=GameLift.DescribeGameServerInstances | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Retrieves status information about the Amazon EC2 in |
| POST | /#X-Amz-Target=GameLift.DescribeGameSessionDetails | <p>Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet l |
| POST | /#X-Amz-Target=GameLift.DescribeGameSessionPlacement | <p>Retrieves information, including current status, about a game session placement request. </p> <p>To get game session placement details, specify the placement |
| POST | /#X-Amz-Target=GameLift.DescribeGameSessionQueues | <p>Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of |
| POST | /#X-Amz-Target=GameLift.DescribeGameSessions | <p>Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.</p> <p>This |
| POST | /#X-Amz-Target=GameLift.DescribeInstances | <p>Retrieves information about a fleet's instances, including instance IDs, connection data, and status. </p> <p>This operation can be used in the following way |
| POST | /#X-Amz-Target=GameLift.DescribeMatchmaking | <p>Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection informa |
| POST | /#X-Amz-Target=GameLift.DescribeMatchmakingConfigurations | <p>Retrieves the details of FlexMatch matchmaking configurations. </p> <p>This operation offers the following options: (1) retrieve all matchmaking configuratio |
| POST | /#X-Amz-Target=GameLift.DescribeMatchmakingRuleSets | <p>Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set n |
| POST | /#X-Amz-Target=GameLift.DescribePlayerSessions | <p>Retrieves properties for one or more player sessions. </p> <p>This action can be used in the following ways: </p> <ul> <li> <p>To retrieve a specific player |
| POST | /#X-Amz-Target=GameLift.DescribeRuntimeConfiguration | <p>Retrieves a fleet's runtime configuration settings. The runtime configuration tells Amazon GameLift which server processes to run (and how) on each instance |
| POST | /#X-Amz-Target=GameLift.DescribeScalingPolicies | <p>Retrieves all scaling policies applied to a fleet.</p> <p>To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy stat |
| POST | /#X-Amz-Target=GameLift.DescribeScript | <p>Retrieves properties for a Realtime script. </p> <p>To request a script record, specify the script ID. If successful, an object containing the script propert |
| POST | /#X-Amz-Target=GameLift.DescribeVpcPeeringAuthorizations | <p>Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and re |
| POST | /#X-Amz-Target=GameLift.DescribeVpcPeeringConnections | <p>Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID. </p> <p>To retri |
| POST | /#X-Amz-Target=GameLift.GetComputeAccess | <p>Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time. </p> <p>T |
| POST | /#X-Amz-Target=GameLift.GetComputeAuthToken | Requests an authentication token from Amazon GameLift. The authentication token is used by your game server to authenticate with Amazon GameLift. Each authentic |
| POST | /#X-Amz-Target=GameLift.GetGameSessionLogUrl | <p>Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the |
| POST | /#X-Amz-Target=GameLift.GetInstanceAccess | <p>Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time. </p> <p>T |
| POST | /#X-Amz-Target=GameLift.ListAliases | <p>Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination para |
| POST | /#X-Amz-Target=GameLift.ListBuilds | <p>Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific statu |
| POST | /#X-Amz-Target=GameLift.ListCompute | Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location. |
| POST | /#X-Amz-Target=GameLift.ListFleets | <p>Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region |
| POST | /#X-Amz-Target=GameLift.ListGameServerGroups | Lists a game server groups. |
| POST | /#X-Amz-Target=GameLift.ListGameServers | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Retrieves information on all game servers that are c |
| POST | /#X-Amz-Target=GameLift.ListLocations | Lists all custom and Amazon Web Services locations. |
| POST | /#X-Amz-Target=GameLift.ListScripts | <p>Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use. </p> <p> <b>Learn more</b> </p> <p> <a hre |
| POST | /#X-Amz-Target=GameLift.ListTagsForResource | <p>Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags to organize Amazon Web Services resources for a range of purposes. This operatio |
| POST | /#X-Amz-Target=GameLift.PutScalingPolicy | <p>Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active |
| POST | /#X-Amz-Target=GameLift.RegisterCompute | <p>Registers your compute resources in a fleet you previously created. After you register a compute to your fleet, you can monitor and manage your compute using |
| POST | /#X-Amz-Target=GameLift.RegisterGameServer | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Creates a new game server resource and notifies Amaz |
| POST | /#X-Amz-Target=GameLift.RequestUploadCredentials | <p>Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build c |
| POST | /#X-Amz-Target=GameLift.ResolveAlias | <p>Retrieves the fleet ID that an alias is currently pointing to.</p> <p> <b>Related actions</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/d |
| POST | /#X-Amz-Target=GameLift.ResumeGameServerGroup | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Reinstates activity on a game server group after it |
| POST | /#X-Amz-Target=GameLift.SearchGameSessions | <p>Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order. </p> <p>This operation is not designed to be co |
| POST | /#X-Amz-Target=GameLift.StartFleetActions | <p>Resumes certain types of activity on fleet instances that were suspended with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleet |
| POST | /#X-Amz-Target=GameLift.StartGameSessionPlacement | <p>Places a request for a new game session in a queue. When processing a placement request, Amazon GameLift searches for available resources on the queue's dest |
| POST | /#X-Amz-Target=GameLift.StartMatchBackfill | <p>Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new ma |
| POST | /#X-Amz-Target=GameLift.StartMatchmaking | <p>Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift managed hosting, this ope |
| POST | /#X-Amz-Target=GameLift.StopFleetActions | <p>Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet act |
| POST | /#X-Amz-Target=GameLift.StopGameSessionPlacement | Cancels a game session placement that is in <code>PENDING</code> status. To stop a placement, provide the placement ID values. If successful, the placement is m |
| POST | /#X-Amz-Target=GameLift.StopMatchmaking | <p>Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If success |
| POST | /#X-Amz-Target=GameLift.SuspendGameServerGroup | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Temporarily stops activity on a game server group wi |
| POST | /#X-Amz-Target=GameLift.TagResource | <p>Assigns a tag to an Amazon GameLift resource. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources |
| POST | /#X-Amz-Target=GameLift.UntagResource | <p>Removes a tag assigned to a Amazon GameLift resource. You can use resource tags to organize Amazon Web Services resources for a range of purposes. This opera |
| POST | /#X-Amz-Target=GameLift.UpdateAlias | <p>Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to |
| POST | /#X-Amz-Target=GameLift.UpdateBuild | <p>Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values |
| POST | /#X-Amz-Target=GameLift.UpdateFleetAttributes | <p>Updates a fleet's mutable attributes, including game session protection and resource creation limits.</p> <p>To update fleet attributes, specify the fleet ID |
| POST | /#X-Amz-Target=GameLift.UpdateFleetCapacity | <p>Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Flee |
| POST | /#X-Amz-Target=GameLift.UpdateFleetPortSettings | <p>Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in the fleet. </p> <p>To update settings, speci |
| POST | /#X-Amz-Target=GameLift.UpdateGameServer | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Updates information about a registered game server t |
| POST | /#X-Amz-Target=GameLift.UpdateGameServerGroup | <p> <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b> </p> <p>Updates Amazon GameLift FleetIQ-specific properties |
| POST | /#X-Amz-Target=GameLift.UpdateGameSession | <p>Updates the mutable properties of a game session. </p> <p>To update a game session, specify the game session ID and the values you want to change. </p> <p>If |
| POST | /#X-Amz-Target=GameLift.UpdateGameSessionQueue | <p>Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue |
Showing the first 100 of 104 endpoints; the full list is in the documentation.
Questions
Does the Amazon GameLift API need an API key?
Yes. The Amazon GameLift API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon GameLift API support HTTPS?
Yes, the Amazon GameLift API is served over HTTPS.
How many endpoints does the Amazon GameLift API have?
Its OpenAPI description lists 104 endpoints in version 2015-10-01. The first 100 are shown on this page.
What are alternatives to the Amazon GameLift 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).