Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

GetApiKey

Gets information about the current ApiKey resource.

Request Syntax


GET /apikeys/api_Key?includeValue=includeValue HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

api_Key

The identifier of the ApiKey resource.

Required: Yes

includeValue

A boolean flag to specify whether (true) or not (false) the result contains the key value.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdDate": number,
   "customerId": "string",
   "description": "string",
   "enabled": boolean,
   "id": "string",
   "lastUpdatedDate": number,
   "name": "string",
   "stageKeys": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "value": "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.

createdDate

The timestamp when the API Key was created.

Type: Timestamp

customerId

An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.

Type: String

description

The description of the API Key.

Type: String

enabled

Specifies whether the API Key can be used by callers.

Type: Boolean

id

The identifier of the API Key.

Type: String

lastUpdatedDate

The timestamp when the API Key was last updated.

Type: Timestamp

name

The name of the API Key.

Type: String

stageKeys

A list of Stage resources that are associated with the ApiKey resource.

Type: Array of strings

tags

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

Type: String to string map

value

The value of the API Key.

Type: String

Errors

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

BadRequestException

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

NotFoundException

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

HTTP Status Code: 404

TooManyRequestsException

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

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401

Examples

Retrieve an API Key

The following example request retrieves an API key.

The successful response returns 200 OK status code and a payload similar to the following:

Sample Request


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

Sample Response


{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-apikey-{rel}.html",
      "name": "apikey",
      "templated": true
    },
    "self": {
      "href": "/apikeys/hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD76"
    },
    "apikey:delete": {
      "href": "/apikeys/hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD76"
    },
    "apikey:update": {
      "href": "/apikeys/hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD76"
    }
  },
  "createdDate": "2015-11-06T23:51:03Z",
  "enabled": true,
  "id": "hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD76",
  "lastUpdatedDate": "2016-06-06T23:44:43Z",
  "name": "my_test_gateway_service",
  "stageKeys": [
    "h4ah70cvmb/beta",
    "fugvjdxtri/stage2"
  ]
}