API Limit Reached

APIs.ioEngineeringPlatform

Properties

Name Type Description
type string The type of error.
title string A short summary of the problem.
message string The error message.
details object Information about the error.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-api403errorlimitreached-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api403ErrorLimitReached",
  "title": "API Limit Reached",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of error.",
      "example": "limitReachedError"
    },
    "title": {
      "type": "string",
      "description": "A short summary of the problem.",
      "example": "You've reached the API limit"
    },
    "message": {
      "type": "string",
      "description": "The error message.",
      "example": "You can create up to 3 APIs on your current plan."
    },
    "details": {
      "type": "object",
      "description": "Information about the error.",
      "properties": {
        "model": {
          "type": "string",
          "description": "The `api` model.",
          "enum": [
            "api"
          ],
          "example": "api"
        },
        "action": {
          "type": "string",
          "description": "The `create` action.",
          "enum": [
            "create"
          ],
          "example": "create"
        },
        "message": {
          "type": "string",
          "description": "The error message.",
          "example": "You can create up to 3 APIs on your current plan."
        }
      }
    }
  }
}