GetClientCertificate - Amazon API Gateway


Gets information about the current ClientCertificate resource.

Request Syntax

GET /clientcertificates/clientcertificate_id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The identifier of the ClientCertificate resource to be described.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "clientCertificateId": "string", "createdDate": number, "description": "string", "expirationDate": number, "pemEncodedCertificate": "string", "tags": { "string" : "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The identifier of the client certificate.

Type: String


The timestamp when the client certificate was created.

Type: Timestamp


The description of the client certificate.

Type: String


The timestamp when the client certificate will expire.

Type: Timestamp


The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Type: String


The collection of tags. Each tag element is associated with a given resource.

Type: String to string map


For information about the errors that are common to all actions, see Common Errors.


The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400


The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404


The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401


Get the client certificate of a given identifier

This example illustrates one usage of GetClientCertificate.

Sample Request

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

Sample Response

{ "_links": { "curies": { "href": "{rel}.html", "name": "clientcertificate", "templated": true }, "self": { "href": "/clientcertificates/9ao60f" }, "clientcertificate:delete": { "href": "/clientcertificates/9ao60f" }, "clientcertificate:update": { "href": "/clientcertificates/9ao60f" } }, "clientCertificateId": "9ao60f", "createdDate": "2016-06-15T22:33:13Z", "description": "my second client-side cert", "expirationDate": "2017-06-15T22:33:13Z", "pemEncodedCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIC6TC...yQAGEHvs=\r\n-----END CERTIFICATE-----" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: