developer.getLimits

This section provides documentation on the v1.0 version of the Mashery API.  We will support previously built applications and integration points, but not granting new access keys.  These pages are for legacy support purposes.  Should you wish to integrate with your Mashery instance, please utilize Mashery API version 2.0.

Description

Retrieves the limits currently set for a developer belonging to a particular Mashery Service Provider.

Authentication

This method requires authentication

Parameters Type Description Required
spkey string Service Provider key assigned by Mashery Yes
email string
Select the developer by email address. Either this value or an API key must be defined. Yes
apikey string Select the developer by API key. Either this value or an email address must be defined. Yes

Response

object — Information on limits for specified developer. See documentation for developer.setLimits for a description of what will be returned.

Examples

A JSON-RPC Request

{
      "method": "developer.getLimit",
      "params": [{
            "spkey": "nzqz4xehpczjrgrjpgbwnskq",
            "where": {
                  "email": "johnqpublic@example.com"
            }
      }],
      "id": 11
}

A JSON-RPC Response

{
      "result": {
            "callsPerPeriod": 0,
            "callsPerPeriodExempt": false,
            "callsPerSecond": 5,
            "callsPerSecondExempt": false,
            "permittedMethods": {
                  "readStuff": {
                        "period": "day"
                         "limit": 5000
                  },
                  "writeStuff": {
                        "period": "day"
                        "limit": 500
                  }
            },
            "permittedPaths": [],
            "permittedHttpMethods": [],
            "requiredReferers": []
            "current": []
      },
      "error": null,
      "id": 11
}

Errors

This method may return one of the following errors:

Error Description
4102: Insufficient Privileges You do not have sufficient privileges to call this method.
400: Bad Request Your request was incomplete or otherwise invalid. Please review the documentation.
450: Spkey Not In Area The service requested does not exist in the area specified.
12: Validation Failed One or more values presented were not acceptable. Please review the documentation.
4006: Developer Invalid Where The 'where' property of your request was incomplete. The properties 'email' and/or 'apikey' must be specified to perform this operation.

Docs Navigation