Amazon API Gateway REST API Reference

apigateway:client-certificates

Gets the ClientCertificates resource representing the set of ClientCertificate resources for all of your APIs.

HTTP Request

GET /clientcertificates

Response

ClientCertificates

Remarks

Error Codes

The following exception may be thrown when the request fails.

  • UnauthorizedException
  • TooManyRequestsException
  • BadRequestException

For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes

The following example request retrieves the available client certificates in the caller's AWS account.

GET /clientcertificates HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160601T175605Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

A successful response returns the requested ClientCertificate resources that can be navigated to by following the linked item or examining the embedded item resource.

{
  "_links": {
    "curies": {
      "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-clientcertificate-{rel}.html",
      "name": "clientcertificate",
      "templated": true
    },
    "self": {
      "href": "/clientcertificates"
    },
    "clientcertificate:by-id": {
      "href": "/clientcertificates/{clientcertificate_id}",
      "templated": true
    },
    "clientcertificate:generate": {
      "href": "/clientcertificates"
    },
    "item": {
      "href": "/clientcertificates/xmbiqp"
    }
  },
  "_embedded": {
    "item": {
      "_links": {
        "self": {
          "href": "/clientcertificates/xmbiqp"
        },
        "clientcertificate:delete": {
          "href": "/clientcertificates/xmbiqp"
        },
        "clientcertificate:update": {
          "href": "/clientcertificates/xmbiqp"
        }
      },
      "clientCertificateId": "xmbiqp",
      "createdDate": "2015-12-08T18:02:16Z",
      "description": "test-client-cert-2",
      "expirationDate": "2016-12-07T18:02:16Z",
      "pemEncodedCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIC6DC...XuHVdZ5r27XRRXEjg==\r\n-----END CERTIFICATE-----"
    }
  }
}

See Also

Enable Client-Side SSL Authentication, AWS CLI