Amazon Outposts Connections API

The Connections API from Amazon Outposts — 2 operation(s) for connections.

GitHub OpenAPI

Operations 2

GET /connections/{ConnectionId} Get Connection #
POST /connections Start Connection #

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/amazon-outposts:amazon-outposts-connections-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. See our Privacy Policy and Terms.

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

OpenAPI Specification

amazon-outposts-connections-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Outposts Connections API
  version: '2019-12-03'
  description: Generated from AWS's published Smithy model for AWS Outposts. 2 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://outposts.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /connections/{ConnectionId}:
    get:
      operationId: GetConnection
      summary: Get Connection
      description: Amazon Web Services uses this action to install Outpost servers. Gets information about the specified connection.
        Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure
        it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon
        Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConnectionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConnectionRequest'
      tags:
      - Connections
  /connections:
    post:
      operationId: StartConnection
      summary: Start Connection
      description: Amazon Web Services uses this action to install Outpost servers. Starts the connection required for Outpost
        server installation. Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services
        Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts
        and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services
        Outposts User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartConnectionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartConnectionRequest'
      tags:
      - Connections
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: outposts
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ConnectionDetails:
      type: object
      properties:
        ClientPublicKey:
          type: string
          description: The public key of the client.
        ServerPublicKey:
          type: string
          description: The public key of the server.
        ServerEndpoint:
          type: string
          description: The endpoint for the server.
        ClientTunnelAddress:
          type: string
          description: The client tunnel address.
        ServerTunnelAddress:
          type: string
          description: The server tunnel address.
        AllowedIps:
          type: array
          items:
            type: string
          description: The allowed IP addresses.
    GetConnectionRequest:
      type: object
      properties:
        ConnectionId:
          type: string
          description: The ID of the connection.
      required:
      - ConnectionId
    GetConnectionResponse:
      type: object
      properties:
        ConnectionId:
          type: string
          description: The ID of the connection.
        ConnectionDetails:
          $ref: '#/components/schemas/ConnectionDetails'
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    StartConnectionRequest:
      type: object
      properties:
        DeviceSerialNumber:
          type: string
          description: The serial number of the dongle.
        AssetId:
          type: string
          description: The ID of the Outpost server.
        ClientPublicKey:
          type: string
          description: The public key of the client.
        NetworkInterfaceDeviceIndex:
          type: integer
          description: The device index of the network interface on the Outpost server.
      required:
      - AssetId
      - ClientPublicKey
      - NetworkInterfaceDeviceIndex
    StartConnectionResponse:
      type: object
      properties:
        ConnectionId:
          type: string
          description: The ID of the connection.
        UnderlayIpAddress:
          type: string
          description: The underlay IP address.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/outposts/service/2019-12-03/outposts-2019-12-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)