Amazon EC2 Keypairs API

Operations for managing SSH key pairs used for instance access

Operations 7

POST /?Action=CreateKeyPair Create Key Pair #
GET /?Action=CreateKeyPair Amazon EC2 Create a Key Pair #
POST /?Action=DeleteKeyPair Delete Key Pair #
GET /?Action=DeleteKeyPair Amazon EC2 Delete a Key Pair #
POST /?Action=DescribeKeyPairs Describe Key Pairs #
GET /?Action=DescribeKeyPairs Amazon EC2 Describe Key Pairs #
POST /?Action=ImportKeyPair Import Key Pair #

Documentation

Specifications

Schemas & Data

Other Resources

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-ec2:amazon-ec2-keypairs-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-ec2-keypairs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Keypairs API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 4 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Keypairs
paths:
  /?Action=CreateKeyPair:
    post:
      operationId: CreateKeyPair
      summary: Create Key Pair
      description: Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error. The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair. You can have up to 5,000 key pairs per Amazon Web Services Region. For more information, see Amazon EC2 key pairs in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/KeyPair'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateKeyPair
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateKeyPairRequest'
            example:
              KeyName: my-key-pair
      tags:
      - Keypairs
    get:
      operationId: createKeyPair
      summary: Amazon EC2 Create a Key Pair
      description: Creates an ED25519 or 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file.
      tags:
      - Keypairs
      parameters:
      - name: KeyName
        in: query
        required: true
        description: A unique name for the key pair
        schema:
          type: string
        example: example-resource-name
      - name: KeyType
        in: query
        description: The type of key pair (rsa or ed25519)
        schema:
          type: string
          enum:
          - rsa
          - ed25519
        example: rsa
      responses:
        '200':
          description: Successfully created key pair
        '400':
          description: Invalid request parameters
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DeleteKeyPair:
    post:
      operationId: DeleteKeyPair
      summary: Delete Key Pair
      description: Deletes the specified key pair, by removing the public key from Amazon EC2.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteKeyPairResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteKeyPair
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteKeyPairRequest'
            example:
              KeyName: my-key-pair
      tags:
      - Keypairs
    get:
      operationId: deleteKeyPair
      summary: Amazon EC2 Delete a Key Pair
      description: Deletes the specified key pair by removing the public key from Amazon EC2.
      tags:
      - Keypairs
      parameters:
      - name: KeyName
        in: query
        description: The name of the key pair to delete
        schema:
          type: string
        example: example-resource-name
      - name: KeyPairId
        in: query
        description: The ID of the key pair to delete
        schema:
          type: string
        example: example-id-1234
      responses:
        '200':
          description: Successfully deleted key pair
        '400':
          description: Invalid request parameters
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DescribeKeyPairs:
    post:
      operationId: DescribeKeyPairs
      summary: Describe Key Pairs
      description: Describes the specified key pairs or all of your key pairs. For more information about key pairs, see Amazon EC2 key pairs in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeKeyPairsResult'
              example:
                KeyPairs:
                - KeyName: my-key-pair
                  KeyFingerprint: 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeKeyPairs
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeKeyPairsRequest'
            example:
              KeyNames:
              - my-key-pair
      tags:
      - Keypairs
    get:
      operationId: describeKeyPairs
      summary: Amazon EC2 Describe Key Pairs
      description: Describes the specified key pairs or all of your key pairs.
      tags:
      - Keypairs
      parameters:
      - name: KeyName
        in: query
        description: The key pair names to describe
        schema:
          type: array
          items:
            type: string
        example:
        - example-resource-name
      - name: KeyPairId
        in: query
        description: The IDs of the key pairs
        schema:
          type: array
          items:
            type: string
        example:
        - example-id-1234
      responses:
        '200':
          description: Successfully described key pairs
        '400':
          description: Invalid request parameters
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=ImportKeyPair:
    post:
      operationId: ImportKeyPair
      summary: Import Key Pair
      description: Imports the public key from an RSA or ED25519 key pair that you created using a third-party tool. You give Amazon Web Services only the public key. The private key is never transferred between you and Amazon Web Services. For more information about the requirements for importing a key pair, see Create a key pair and import the public key to Amazon EC2 in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ImportKeyPairResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ImportKeyPair
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ImportKeyPairRequest'
      tags:
      - Keypairs
components:
  schemas:
    DescribeKeyPairsRequest:
      type: object
      properties:
        KeyNames:
          type: array
          items:
            type: string
          description: 'The key pair names. Default: Describes all of your key pairs.'
        KeyPairIds:
          type: array
          items:
            type: string
          description: The IDs of the key pairs.
        IncludePublicKey:
          type: boolean
          description: 'If true, the public key material is included in the response. Default: false'
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'The filters. key-pair-id - The ID of the key pair. fingerprint - The fingerprint of the key pair. key-name - The name of the key pair. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
    ImportKeyPairResult:
      type: object
      properties:
        KeyFingerprint:
          type: string
          description: For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716. For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
        KeyName:
          type: string
          description: The key pair name that you provided.
        KeyPairId:
          type: string
          description: The ID of the resulting key pair.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags applied to the imported key pair.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    CreateKeyPairRequest:
      type: object
      properties:
        KeyName:
          type: string
          description: 'A unique name for the key pair. Constraints: Up to 255 ASCII characters'
        KeyType:
          type: string
          enum:
          - rsa
          - ed25519
          description: 'The type of key pair. Note that ED25519 keys are not supported for Windows instances. Default: rsa'
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the new key pair.
        KeyFormat:
          type: string
          enum:
          - pem
          - ppk
          description: 'The format of the key pair. Default: pem'
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - KeyName
    KeyPairInfo:
      type: object
      properties:
        KeyPairId:
          type: string
          description: The ID of the key pair.
        KeyType:
          type: string
          enum:
          - rsa
          - ed25519
          description: The type of key pair.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags applied to the key pair.
        PublicKey:
          type: string
          description: The public key material.
        CreateTime:
          type: string
          format: date-time
          description: If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone. If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.
        KeyName:
          type: string
          description: The name of the key pair.
        KeyFingerprint:
          type: string
          description: 'If you used CreateKeyPair to create the key pair: For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. If you used ImportKeyPair to provide Amazon Web Services the public key: For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716. For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with Open'
    DeleteKeyPairResult:
      type: object
      properties:
        Return:
          type: boolean
          description: Is true if the request succeeds, and an error otherwise.
        KeyPairId:
          type: string
          description: The ID of the key pair.
    KeyPair:
      type: object
      properties:
        KeyPairId:
          type: string
          description: The ID of the key pair.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags applied to the key pair.
        KeyName:
          type: string
          description: The name of the key pair.
        KeyFingerprint:
          type: string
          description: For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
        KeyMaterial:
          type: string
          description: An unencrypted PEM encoded RSA or ED25519 private key.
    DeleteKeyPairRequest:
      type: object
      properties:
        KeyName:
          type: string
          description: The name of the key pair.
        KeyPairId:
          type: string
          description: The ID of the key pair.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    DescribeKeyPairsResult:
      type: object
      properties:
        KeyPairs:
          type: array
          items:
            $ref: '#/components/schemas/KeyPairInfo'
          description: Information about the key pairs.
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    ImportKeyPairRequest:
      type: object
      properties:
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the imported key pair.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        KeyName:
          type: string
          description: A unique name for the key pair.
        PublicKeyMaterial:
          type: string
          format: byte
          description: The public key.
      required:
      - KeyName
      - PublicKeyMaterial
  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: ec2
    sigv4Auth:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)