{
  "opencollection": "1.0.0",
  "info": {
    "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Usageplans API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Usageplans",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GetUsagePlans",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "position",
                "value": "",
                "type": "query",
                "description": "The current pagination position in the paged result set."
              },
              {
                "name": "keyId",
                "value": "",
                "type": "query",
                "description": "The identifier of the API key associated with the usage plans."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500."
              }
            ]
          },
          "docs": "Gets all the usage plans of the caller's account."
        },
        {
          "info": {
            "name": "CreateUsagePlan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. "
        },
        {
          "info": {
            "name": "GetUsagePlanKeys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans/:usageplanId/keys",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "usageplanId",
                "value": "",
                "type": "path",
                "description": "The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer."
              },
              {
                "name": "position",
                "value": "",
                "type": "query",
                "description": "The current pagination position in the paged result set."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "A query parameter specifying the name of the to-be-returned usage plan keys."
              }
            ]
          },
          "docs": "Gets all the usage plan keys representing the API keys added to a specified usage plan."
        },
        {
          "info": {
            "name": "CreateUsagePlanKey",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans/:usageplanId/keys",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "usageplanId",
                "value": "",
                "type": "path",
                "description": "The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a usage plan key for adding an existing API key to a usage plan."
        },
        {
          "info": {
            "name": "GetUsagePlan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans/:usageplanId",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "usageplanId",
                "value": "",
                "type": "path",
                "description": "The identifier of the UsagePlan resource to be retrieved."
              }
            ]
          },
          "docs": "Gets a usage plan of a given plan identifier."
        },
        {
          "info": {
            "name": "UpdateUsagePlan",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans/:usageplanId",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "usageplanId",
                "value": "",
                "type": "path",
                "description": "The Id of the to-be-updated usage plan."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a usage plan of a given plan Id."
        },
        {
          "info": {
            "name": "DeleteUsagePlan",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans/:usageplanId",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "usageplanId",
                "value": "",
                "type": "path",
                "description": "The Id of the to-be-deleted usage plan."
              }
            ]
          },
          "docs": "Deletes a usage plan of a given plan Id."
        },
        {
          "info": {
            "name": "GetUsagePlanKey",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans/:usageplanId/keys/:keyId",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "usageplanId",
                "value": "",
                "type": "path",
                "description": "The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer."
              },
              {
                "name": "keyId",
                "value": "",
                "type": "path",
                "description": "The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer."
              }
            ]
          },
          "docs": "Gets a usage plan key of a given key identifier."
        },
        {
          "info": {
            "name": "DeleteUsagePlanKey",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans/:usageplanId/keys/:keyId",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "usageplanId",
                "value": "",
                "type": "path",
                "description": "The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer."
              },
              {
                "name": "keyId",
                "value": "",
                "type": "path",
                "description": "The Id of the UsagePlanKey resource to be deleted."
              }
            ]
          },
          "docs": "Deletes a usage plan key and remove the underlying API key from the associated usage plan."
        },
        {
          "info": {
            "name": "GetUsage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans/:usageplanId/usage#startDate&endDate",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "usageplanId",
                "value": "",
                "type": "path",
                "description": "The Id of the usage plan associated with the usage data."
              },
              {
                "name": "keyId",
                "value": "",
                "type": "query",
                "description": "The Id of the API key associated with the resultant usage data."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The starting date (e.g., 2016-01-01) of the usage data."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The ending date (e.g., 2016-12-31) of the usage data."
              },
              {
                "name": "position",
                "value": "",
                "type": "query",
                "description": "The current pagination position in the paged result set."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500."
              }
            ]
          },
          "docs": "Gets the usage data of a usage plan in a specified time interval."
        },
        {
          "info": {
            "name": "UpdateUsage",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://apigateway.{region}.amazonaws.com/usageplans/:usageplanId/keys/:keyId/usage",
            "headers": [
              {
                "name": "X-Amz-Content-Sha256",
                "value": ""
              },
              {
                "name": "X-Amz-Date",
                "value": ""
              },
              {
                "name": "X-Amz-Algorithm",
                "value": ""
              },
              {
                "name": "X-Amz-Credential",
                "value": ""
              },
              {
                "name": "X-Amz-Security-Token",
                "value": ""
              },
              {
                "name": "X-Amz-Signature",
                "value": ""
              },
              {
                "name": "X-Amz-SignedHeaders",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "usageplanId",
                "value": "",
                "type": "path",
                "description": "The Id of the usage plan associated with the usage data."
              },
              {
                "name": "keyId",
                "value": "",
                "type": "path",
                "description": "The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key."
        }
      ]
    }
  ],
  "bundled": true
}