openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 mTLS Certificate Management API
description:
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: mTLS Certificate Management paths: /accounts/{account_id}/mtls_certificates: get: description: Lists all mTLS certificates. operationId: m-tls-certificate-management-list-m-tls-certificates parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' description: List mTLS certificates response failure '200': content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection' description: List mTLS certificates response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform List mTLS certificates tags: - mTLS Certificate Management x-api-token-group: - 'Account: SSL and Certificates Read' - 'Account: SSL and Certificates Write' x-cfPermissionsRequired: enum: - '#ssl:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true post: description: Upload a certificate that you want to use with mTLS-enabled Cloudflare services. operationId: m-tls-certificate-management-upload-m-tls-certificate parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: content: application/json: schema: properties: ca: $ref: '#/components/schemas/tls-certificates-and-hostnames_ca' certificates: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificates' name: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-name' private_key: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-private_key' required: - certificates - ca type: object required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_post' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' description: Upload mTLS certificate response failure '200': content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_post' description: Upload mTLS certificate response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Upload mTLS certificate tags: - mTLS Certificate Management x-api-token-group: - 'Account: SSL and Certificates Write' x-cfPermissionsRequired: enum: - '#ssl:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}: delete: description: Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services. operationId: m-tls-certificate-management-delete-m-tls-certificate parameters: - in: path name: mtls_certificate_id required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: content: application/json: {} required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' description: Delete mTLS certificate response failure '200': content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single' description: Delete mTLS certificate response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete mTLS certificate tags: - mTLS Certificate Management x-api-token-group: - 'Account: SSL and Certificates Write' x-cfPermissionsRequired: enum: - '#ssl:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true get: description: Fetches a single mTLS certificate. operationId: m-tls-certificate-management-get-m-tls-certificate parameters: - in: path name: mtls_certificate_id required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' description: Get mTLS certificate response failure '200': content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single' description: Get mTLS certificate response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get mTLS certificate tags: - mTLS Certificate Management x-api-token-group: - 'Account: SSL and Certificates Read' - 'Account: SSL and Certificates Write' x-cfPermissionsRequired: enum: - '#ssl:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations: get: description: Lists all active associations between the certificate and Cloudflare services. operationId: m-tls-certificate-management-list-m-tls-certificate-associations parameters: - in: path name: mtls_certificate_id required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - in: path name: account_id required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_association_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' description: List mTLS certificate associations response failure '200': content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_association_response_collection' description: List mTLS certificate associations response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform List mTLS certificate associations tags: - mTLS Certificate Management x-api-token-group: - 'Account: SSL and Certificates Read' - 'Account: SSL and Certificates Write' x-cfPermissionsRequired: enum: - '#ssl:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true components: schemas: tls-certificates-and-hostnames_components-schemas-private_key: description: The private key for the certificate example: '-----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDEXDkcICRU3XBv9hiiPnBWIjgTQyowmVFxDr11mONgZB/cMYjE/OvQjvnpwNcOaSK16MOpAjNbELKRx2lZiVJaLRDCccqCxXwP/CrdRChcqGzo7mbNksMlcidrErb0LlEBKLFC2QjRmRKqB+YOs4TD8WsZu2S667A2fZmjRlaqOxFi1h62ee0P+TLU628UC/nl41JifSt5Evt7hMDHakemdwZblNYr2p6T3NQjdhjYXTtP4UmOGJBhJ7i7Kicg3d3CIgdTMbggSeGWqjndr4ldVnD96FN3cVT5uDFsn2CJXTFgdeBWoUnMS4VnUZzPWGf4vSBXC8qV7Ls+w46yT7T1AgMBAAECggEAQZnp/oqCeNPOR6l5S2L+1tfx0gWjZ78hJVteUpZ0iHSK7F6kKeOxyOird7vUXV0kmo+cJq+0hp0Ke4eam640FCpwKfYoSQ4/R3vgujGWJnaihCN5tv5sMet0XeJPuz5qE7ALoKCvwI6aXLHs20aAeZIDTQJ9QbGSGnJVzOWn+JDTidIgZpN57RpXfSAwnJPTQK/PN8i5z108hsaDOdEgGmxYZ7kYqMqzX20KXmth58LDfPixs5JGtS60iiKC/wOcGzkB2/AdTSojR76oEU77cANP/3zO25NG//whUdYlW0t0d7PgXxIeJe+xgYnamDQJx3qonVyt4H77ha0ObRAj9QKBgQDicZr+VTwFMnELP3a+FXGnjehRiuS1i7MXGKxNweCD+dFlML0FplSQS8Ro2n+d8lu8BBXGx0qm6VXu8Rhn7TAUL6q+PCgfarzxfIhacb/TZCqfieIHsMlVBfhV5HCXnk+kis0tuC/PRArcWTwDHJUJXkBhvkUsNswvQzavDPI7KwKBgQDd/WgLkj7A3X5fgIHZH/GbDSBiXwzKb+rF4ZCT2XFgG/OAW7vapfcX/w+v+5lBLyrocmOAS3PGGAhM5T3HLnUCQfnK4qgps1Lqibkc9Tmnsn60LanUjuUMsYv/zSw70tozbzhJ0pioEpWfRxRZBztO2Rr8Ntm7h6Fk701EXGNAXwKBgQCD1xsjy2J3sCerIdcz0u5qXLAPkeuZW+34m4/ucdwTWwc0gEz9lhsULFj9p4G351zLuiEnq+7mAWLcDJlmIO3mQt6JhiLiL9Y0T4pgBmxmWqKKYtAsJB0EmMY+1BNN44mBRqMxZFTJu1cLdhT/xstrOeoIPqytknYNanfTMZlzIwKBgHrLXe5oq0XMP8dcMneEcAUwsaU4pr6kQd3L9EmUkl5zl7J9C+DaxWAEuwzBw/iGutlxzRB+rD/7szu14wJ29EqXbDGKRzMp+se5/yfBjm7xEZ1hVPw7PwBShfqt57X/4Ktq7lwHnmH6RcGhc+P7WBc5iO/S94YAdIp8xOT3pf9JAoGAE0QkqJUY+5Mgr+fBO0VNV72ZoPveGpW+De59uhKAOnu1zljQCUtk59m6+DXfm0tNYKtawa5n8iN71Zh+s62xXSt3pYi1Y5CCCmv8Y4BhwIcPwXKk3zEvLgSHVTpC0bayA9aSO4bbZgVXa5w+Z0w/vvfp9DWo1IS3EnQRrz6WMYA= -----END PRIVATE KEY-----' type: string tls-certificates-and-hostnames_ca: description: Indicates whether the certificate is a CA or leaf certificate. example: true type: boolean tls-certificates-and-hostnames_certificate_response_single_post: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - properties: result: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificateObjectPost' type: object tls-certificates-and-hostnames_identifier: description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 type: string tls-certificates-and-hostnames_schemas-issuer: description: The certificate authority that issued the certificate. example: O=Example Inc.,L=California,ST=San Francisco,C=US readOnly: true type: string tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single' - properties: result: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificateObject' type: object tls-certificates-and-hostnames_result_info: properties: count: description: Total number of results for the requested service example: 1 type: number page: description: Current page within paginated list of results example: 1 type: number per_page: description: Number of results per page of results example: 20 type: number total_count: description: Total results available without any search parameters example: 2000 type: number type: object tls-certificates-and-hostnames_association_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: items: $ref: '#/components/schemas/tls-certificates-and-hostnames_associationObject' type: array tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on: description: This is the time the certificate was uploaded. example: '2022-11-22T17:32:30.467938Z' format: date-time type: string tls-certificates-and-hostnames_api-response-common: properties: errors: $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' messages: $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' success: description: Whether the API call was successful enum: - true example: true type: boolean required: - success - errors - messages type: object tls-certificates-and-hostnames_components-schemas-certificateObject: properties: ca: $ref: '#/components/schemas/tls-certificates-and-hostnames_ca' certificates: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificates' expires_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' issuer: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-issuer' name: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-name' serial_number: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-serial_number' signature: $ref: '#/components/schemas/tls-certificates-and-hostnames_signature' uploaded_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on' tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on: description: When the certificate expires. example: '2122-10-29T16:59:47Z' format: date-time readOnly: true type: string tls-certificates-and-hostnames_signature: description: The type of hash used for the certificate. example: SHA256WithRSA readOnly: true type: string tls-certificates-and-hostnames_associationObject: properties: service: $ref: '#/components/schemas/tls-certificates-and-hostnames_service' status: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-status' tls-certificates-and-hostnames_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array tls-certificates-and-hostnames_schemas-name: description: Optional unique name for the certificate. Only used for human readability. example: example_ca_cert type: string tls-certificates-and-hostnames_mtls-management_components-schemas-status: description: Certificate deployment status for the given service. example: pending_deployment type: string tls-certificates-and-hostnames_schemas-serial_number: description: The certificate serial number. example: '235217144297995885180570755458463043449861756659' readOnly: true type: string tls-certificates-and-hostnames_service: description: The service using the certificate. example: gateway type: string tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection' - properties: result: items: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificateObject' type: array - properties: result_info: properties: count: example: 1 page: example: 1 per_page: example: 50 total_count: example: 1 total_pages: description: Total pages available of results example: 1 type: number type: object tls-certificates-and-hostnames_components-schemas-updated_at: description: This is the time the certificate was updated. example: '2022-11-22T17:32:30.467938Z' format: date-time type: string tls-certificates-and-hostnames_schemas-certificates: description: The uploaded root CA certificate. example: '-----BEGIN CERTIFICATE----- MIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIxNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwgJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kCM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1MxuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcLypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ7111Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTii7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomoShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4JhqeoTewsxndhDDE -----END CERTIFICATE-----' type: string tls-certificates-and-hostnames_certificateObjectPost: properties: ca: $ref: '#/components/schemas/tls-certificates-and-hostnames_ca' certificates: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificates' expires_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' issuer: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-issuer' name: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-name' serial_number: $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-serial_number' signature: $ref: '#/components/schemas/tls-certificates-and-hostnames_signature' updated_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at' uploaded_on: $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on' tls-certificates-and-hostnames_api-response-single: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common' type: object tls-certificates-and-hostnames_api-response-collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common' - properties: result_info: $ref: '#/components/schemas/tls-certificates-and-hostnames_result_info' type: object tls-certificates-and-hostnames_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' example: [] result: enum: - null nullable: true type: object success: description: Whether the API call was successful enum: - false example: false type: boolean required: - success - errors - messages - result type: object securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true