Amazon Web Services, Inc.

AWS Backup Gateway

Backup gateway Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere,…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Backup gateway Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services. Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor. Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup. To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways , then choose Create gateway .

Endpoints 25

Gateway

  • POSTAssociate gateway to server/#X-Amz-Target=BackupOnPremises_v20210101.AssociateGatewayToServerAssociates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
  • POSTCreate gateway/#X-Amz-Target=BackupOnPremises_v20210101.CreateGatewayCreates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.
  • POSTDelete gateway/#X-Amz-Target=BackupOnPremises_v20210101.DeleteGatewayDeletes a backup gateway.
  • POSTDisassociate gateway from server/#X-Amz-Target=BackupOnPremises_v20210101.DisassociateGatewayFromServerDisassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on…
  • POSTGet gateway/#X-Amz-Target=BackupOnPremises_v20210101.GetGatewayBy providing the ARN (Amazon Resource Name), this API returns the gateway.
  • POSTList gateways/#X-Amz-Target=BackupOnPremises_v20210101.ListGatewaysLists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name…
  • POSTPut maintenance start time/#X-Amz-Target=BackupOnPremises_v20210101.PutMaintenanceStartTimeSet the maintenance start time for a gateway.
  • POSTTest hypervisor configuration/#X-Amz-Target=BackupOnPremises_v20210101.TestHypervisorConfigurationTests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
  • POSTUpdate gateway information/#X-Amz-Target=BackupOnPremises_v20210101.UpdateGatewayInformationUpdates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
  • POSTUpdate gateway software now/#X-Amz-Target=BackupOnPremises_v20210101.UpdateGatewaySoftwareNowUpdates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success…

Hypervisor

  • POSTDelete hypervisor/#X-Amz-Target=BackupOnPremises_v20210101.DeleteHypervisorDeletes a hypervisor.
  • POSTGet hypervisor/#X-Amz-Target=BackupOnPremises_v20210101.GetHypervisorThis action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that…
  • POSTImport hypervisor configuration/#X-Amz-Target=BackupOnPremises_v20210101.ImportHypervisorConfigurationConnect to a hypervisor by importing its configuration.
  • POSTList hypervisors/#X-Amz-Target=BackupOnPremises_v20210101.ListHypervisorsLists your hypervisors.
  • POSTStart virtual machines metadata sync/#X-Amz-Target=BackupOnPremises_v20210101.StartVirtualMachinesMetadataSyncThis action sends a request to sync metadata across the specified virtual machines.
  • POSTUpdate hypervisor/#X-Amz-Target=BackupOnPremises_v20210101.UpdateHypervisorUpdates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the…

Bandwidth rate limit schedule

  • POSTGet bandwidth rate limit schedule/#X-Amz-Target=BackupOnPremises_v20210101.GetBandwidthRateLimitScheduleRetrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth…
  • POSTPut bandwidth rate limit schedule/#X-Amz-Target=BackupOnPremises_v20210101.PutBandwidthRateLimitScheduleThis action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no…

Hypervisor property mapping

  • POSTGet hypervisor property mappings/#X-Amz-Target=BackupOnPremises_v20210101.GetHypervisorPropertyMappingsThis action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties…
  • POSTPut hypervisor property mappings/#X-Amz-Target=BackupOnPremises_v20210101.PutHypervisorPropertyMappingsThis action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available…

Virtual machine

  • POSTGet virtual machine/#X-Amz-Target=BackupOnPremises_v20210101.GetVirtualMachineBy providing the ARN (Amazon Resource Name), this API returns the virtual machine.
  • POSTList virtual machines/#X-Amz-Target=BackupOnPremises_v20210101.ListVirtualMachinesLists your virtual machines.
  • POSTList tags for resource/#X-Amz-Target=BackupOnPremises_v20210101.ListTagsForResourceLists the tags applied to the resource identified by its Amazon Resource Name (ARN).
  • POSTTag resource/#X-Amz-Target=BackupOnPremises_v20210101.TagResourceTag the resource.
  • POSTUntag resource/#X-Amz-Target=BackupOnPremises_v20210101.UntagResourceRemoves tags from the resource.

API details

Base URL
https://backup-gateway.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
25 operations on 25 pathsPOST 25
Main resources
Gateway 10Hypervisor 6Bandwidth rate limit schedule 2Hypervisor property mapping 2Virtual machine 2
Description format
AWS Smithy model, API version 2021-01-01

How to test the AWS Backup Gateway in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Backup Gateway collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate gateway to server” (POST /#X-Amz-Target=BackupOnPremises_v20210101.AssociateGatewayToServer), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Backup Gateway?

Backup gateway Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere,… It is listed under Developer tools and has 25 endpoints.

Who publishes the AWS Backup Gateway?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Backup Gateway?

Requests go to https://backup-gateway.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Backup Gateway?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Backup Gateway have?

25 operations on 25 paths (25 POST). The largest groups are Gateway, Hypervisor, Bandwidth rate limit schedule, Hypervisor property mapping.

Is forking the AWS Backup Gateway free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.