Amazon API Gateway REST API Reference

usageplan:by-id

Gets a usage plan of a given Id.

HTTP Request

GET /usageplans/{usageplanId}

Template Variable

Response

UsagePlan

Remarks

Example

Request
GET /usageplans/n371pt HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160805T012305Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sigvv4_hash}
Response
{
  "_links": {
    "curies": [
      {
        "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usage-{rel}.html",
        "name": "usage",
        "templated": true
      },
      {
        "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplan-{rel}.html",
        "name": "usageplan",
        "templated": true
      },
      {
        "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplankey-{rel}.html",
        "name": "usageplankey",
        "templated": true
      }
    ],
    "self": {
      "href": "/usageplans/n371pt"
    },
    "usage:get": {
      "href": "/usageplans/n371pt/usage?startDate=2016-07-06&endDate=2016-08-05"
    },
    "usageplan:delete": {
      "href": "/usageplans/n371pt"
    },
    "usageplan:update": {
      "href": "/usageplans/n371pt"
    },
    "usageplan:usageplankeys": {
      "href": "/usageplans/n371pt/keys"
    },
    "usageplankey:create": {
      "href": "/usageplans/n371pt/keys"
    }
  },
  "apiStages": {
    "stage": "testStage",
    "apiId": "kdwpu39c2k"
  },
  "id": "n371pt",
  "name": "Plan_D",
  "quota": {
    "period": "DAY",
    "offset": 0,
    "limit": 5
  },
  "throttle": {
    "rateLimit": 100,
    "burstLimit": 200
  }
}

See Also

Create and Use Usage Plans