AWS Backup Backup Gateway API

The Backup Gateway API from AWS Backup — 6 operation(s) for backup gateway.

GitHub OpenAPI

Operations 6

POST /#AssociateGatewayToServer Associate Gateway To Server #
POST /#DisassociateGatewayFromServer Disassociate Gateway From Server #
POST /#CreateGateway Create Gateway #
POST /#GetGateway Get Gateway #
POST /#DeleteGateway Delete Gateway #
POST /#ListGateways List Gateways #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/aws-backup:aws-backup-gateway-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aws-backup-gateway-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Backup Gateway API
  version: '2018-11-15'
  description: Generated from AWS's published Smithy model for AWS Backup. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://backup-gateway.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#AssociateGatewayToServer:
    post:
      operationId: AssociateGatewayToServer
      summary: Associate Gateway To Server
      description: Associates a backup gateway with your server. After you complete the association process, you can back
        up and restore your VMs through the gateway.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AssociateGatewayToServerOutput'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BackupGatewayConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BackupOnPremises_v20210101.AssociateGatewayToServer
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/AssociateGatewayToServerInput'
      tags:
      - Gateway
  /#DisassociateGatewayFromServer:
    post:
      operationId: DisassociateGatewayFromServer
      summary: Disassociate Gateway From Server
      description: Disassociates a backup gateway from the specified server. After the disassociation process finishes, the
        gateway can no longer access the virtual machines on the server.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DisassociateGatewayFromServerOutput'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BackupGatewayConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BackupGatewayResourceNotFoundException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BackupOnPremises_v20210101.DisassociateGatewayFromServer
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DisassociateGatewayFromServerInput'
      tags:
      - Gateway
  /#CreateGateway:
    post:
      operationId: CreateGateway
      summary: Create Gateway
      description: Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer
        operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateGatewayOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BackupOnPremises_v20210101.CreateGateway
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateGatewayInput'
      tags:
      - Gateway
  /#GetGateway:
    post:
      operationId: GetGateway
      summary: Get Gateway
      description: By providing the ARN (Amazon Resource Name), this API returns the gateway.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetGatewayOutput'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BackupGatewayResourceNotFoundException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BackupOnPremises_v20210101.GetGateway
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetGatewayInput'
      tags:
      - Gateway
  /#DeleteGateway:
    post:
      operationId: DeleteGateway
      summary: Delete Gateway
      description: Deletes a backup gateway.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteGatewayOutput'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/BackupGatewayResourceNotFoundException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BackupOnPremises_v20210101.DeleteGateway
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteGatewayInput'
      tags:
      - Gateway
  /#ListGateways:
    post:
      operationId: ListGateways
      summary: List Gateways
      description: Lists 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 (ARN).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListGatewaysOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BackupOnPremises_v20210101.ListGateways
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListGatewaysInput'
      tags:
      - Gateway
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: backup-gateway
  schemas:
    AssociateGatewayToServerInput:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways
            for your account and Amazon Web Services Region.
        ServerArn:
          type: string
          description: The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
      required:
      - GatewayArn
      - ServerArn
    AssociateGatewayToServerOutput:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of a gateway.
    BackupGatewayConflictException:
      type: object
      properties:
        ErrorCode:
          type: string
          description: A description of why the operation is not supported.
        Message:
          type: string
      required:
      - ErrorCode
    BackupGatewayResourceNotFoundException:
      type: object
      properties:
        ErrorCode:
          type: string
          description: A description of which resource wasn't found.
        Message:
          type: string
    CreateGatewayInput:
      type: object
      properties:
        ActivationKey:
          type: string
          description: The activation key of the created gateway.
        GatewayDisplayName:
          type: string
          description: The display name of the created gateway.
        GatewayType:
          type: string
          description: The type of created gateway.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
      required:
      - ActivationKey
      - GatewayDisplayName
      - GatewayType
    CreateGatewayOutput:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway you create.
    DeleteGatewayInput:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway to delete.
      required:
      - GatewayArn
    DeleteGatewayOutput:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway you deleted.
    DisassociateGatewayFromServerInput:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway to disassociate.
      required:
      - GatewayArn
    DisassociateGatewayFromServerOutput:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway you disassociated.
    Gateway:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways
            for your account and Amazon Web Services Region.
        GatewayDisplayName:
          type: string
          description: The display name of the gateway.
        GatewayType:
          type: string
          description: The type of the gateway.
        HypervisorId:
          type: string
          description: The hypervisor ID of the gateway.
        LastSeenTime:
          type: string
          format: date-time
          description: The last time Backup gateway communicated with the gateway, in Unix format and UTC time.
    GatewayDetails:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways
            for your account and Amazon Web Services Region.
        GatewayDisplayName:
          type: string
          description: The display name of the gateway.
        GatewayType:
          type: string
          description: The type of the gateway type.
        HypervisorId:
          type: string
          description: The hypervisor ID of the gateway.
        LastSeenTime:
          type: string
          format: date-time
          description: Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.
        MaintenanceStartTime:
          $ref: '#/components/schemas/MaintenanceStartTime'
        NextUpdateAvailabilityTime:
          type: string
          format: date-time
          description: Details showing the next update availability time of the gateway.
        VpcEndpoint:
          type: string
          description: The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud
            for backup gateway.
        DeprecationDate:
          type: string
          format: date-time
          description: Date after which this gateway will not receive software updates for new features and bug fixes.
        SoftwareVersion:
          type: string
          description: The version number of the software running on the gateway appliance.
    GetGatewayInput:
      type: object
      properties:
        GatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the gateway.
      required:
      - GatewayArn
    GetGatewayOutput:
      type: object
      properties:
        Gateway:
          $ref: '#/components/schemas/GatewayDetails'
    InternalServerException:
      type: object
      properties:
        ErrorCode:
          type: string
          description: A description of which internal error occured.
        Message:
          type: string
    ListGatewaysInput:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of gateways to list.
        NextToken:
          type: string
          description: The next item following a partial list of returned resources. For example, if a request is made to
            return MaxResults number of resources, NextToken allows you to return more items in your list starting at the
            location pointed to by the next token.
    ListGatewaysOutput:
      type: object
      properties:
        Gateways:
          type: array
          items:
            $ref: '#/components/schemas/Gateway'
          description: A list of your gateways.
        NextToken:
          type: string
          description: The next item following a partial list of returned resources. For example, if a request is made to
            return maxResults number of resources, NextToken allows you to return more items in your list starting at the
            location pointed to by the next token.
    MaintenanceStartTime:
      type: object
      properties:
        DayOfMonth:
          type: integer
          description: The day of the month component of the maintenance start time represented as an ordinal number from
            1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
        DayOfWeek:
          type: integer
          description: An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and
            6 represents Saturday. The day of week is in the time zone of the gateway.
        HourOfDay:
          type: integer
          description: The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23).
            The hour of the day is in the time zone of the gateway.
        MinuteOfHour:
          type: integer
          description: The minute component of the maintenance start time represented as mm, where mm is the minute (0 to
            59). The minute of the hour is in the time zone of the gateway.
      required:
      - HourOfDay
      - MinuteOfHour
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key part of a tag's key-value pair. The key can't start with aws:.
        Value:
          type: string
          description: The value part of a tag's key-value pair.
      required:
      - Key
      - Value
    ThrottlingException:
      type: object
      properties:
        ErrorCode:
          type: string
          description: 'Error: TPS has been limited to protect against intentional or unintentional high request volumes.'
        Message:
          type: string
      required:
      - ErrorCode
    ValidationException:
      type: object
      properties:
        ErrorCode:
          type: string
          description: A description of what caused the validation error.
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/backup-gateway/service/2021-01-01/backup-gateway-2021-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)