Amazon Storage Gateway Amazon Storage Gateway REST API API

The Amazon Storage Gateway REST API API from Amazon Storage Gateway — 1 operation(s) for amazon storage gateway rest api.

OpenAPI Specification

amazon-storage-gateway-amazon-storage-gateway-rest-api-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Storage Gateway REST Amazon Storage Gateway REST API API
  description: AWS Storage Gateway is a hybrid cloud storage service that gives you on-premises access to virtually unlimited cloud storage. This API enables management of gateways, volumes, virtual tapes, file shares, and cached storage resources.
  version: '2013-06-30'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://aws.amazon.com/service-terms/
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://storagegateway.{region}.amazonaws.com
  description: Amazon Storage Gateway regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-central-1
      - ap-northeast-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
security:
- sigv4: []
tags:
- name: Amazon Storage Gateway REST API
paths:
  /:
    post:
      summary: Amazon Storage Gateway Activate Gateway
      description: Activates the gateway you previously deployed on your host.
      operationId: activateGateway
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ActivateGatewayInput'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivateGatewayOutput'
      x-amz-target: StorageGateway_20130630.ActivateGateway
      tags:
      - Amazon Storage Gateway REST API
components:
  schemas:
    ActivateGatewayOutput:
      type: object
      properties:
        GatewayARN:
          type: string
    ActivateGatewayInput:
      type: object
      required:
      - ActivationKey
      - GatewayName
      - GatewayTimezone
      - GatewayRegion
      properties:
        ActivationKey:
          type: string
          description: Your gateway activation key.
        GatewayName:
          type: string
          description: The name you configured for your gateway.
        GatewayTimezone:
          type: string
          description: A value that indicates the time zone you want to set for the gateway.
        GatewayRegion:
          type: string
          description: A value that indicates the AWS Region where you want to store your data.
        GatewayType:
          type: string
          enum:
          - STORED
          - CACHED
          - VTL
          - S3_FILE_GATEWAY
          - FSX_SMB
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4
externalDocs:
  description: Amazon Storage Gateway API Reference
  url: https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html