• Register

Method Overrides

Description

A method override object contains limit overrides that can be set for package keys, changing limits at the method level and turning on or off response filtering.

NOTE:This object is available when API Packager is turned on for a customer. Please contact Support or your Account Manager if you have any questions about API Packager.

Object Fields

id

The id field is the primary identifier for the object.

type maxLength format default optional readonly createonly queryable sortable
integer no yes no yes no

rate_limit_ceiling

API Key specific Rate Limit the Proxy Service will enforce if both Rate Limit Enforcement is enabled and Rate Limit Overrides are allowed in the Dashboard API Settings Tab. This value takes precidence over the Service Definition Default Rate Limit. Note: The period ("Minute", "Hour", "Day", "Month") for the rate_limit_ceiling (Custom Rate Limit) is set in the Service Definition's Rate Limit Period configuration item in the Dashboard API Settings Tab.

type maxLength format default optional readonly createonly queryable sortable
integer no no no yes no

rate_limit_exempt

Toggle whether this key has an unlimited rate limit. This setting is only applied by the Proxy Service at runtime if the Rate Limit feature is enabled and the Default Rate Limit Override is allowed.

type maxLength format default optional readonly createonly queryable sortable
boolean no no no yes no

qps_limit_ceiling

API Key specific QPS Limit the Proxy Service will enforce if both Throttling Limit Enforcement is enabled and Throttling Limit Overrides are allowed in the Dashboard API Settings Tab. This value takes precedence over the Service Definition Default Rate Limit. This value is only enforced if the Aggregate QPS has not been reached for the Service Definition.

type maxLength format default optional readonly createonly queryable sortable
integer no no no yes no

qps_limit_exempt

Toggle whether this key allows unlimted qps. This setting is only applied by the Proxy Service at runtime if the Throttling Limit Enforcement feature is enabled and Throttling Limit Override is allowed. This setting does not take precidence over any Aggregate QPS setting on the service definition.

type maxLength format default optional readonly createonly queryable sortable
boolean no no no yes no

response_filter_exempt

 

type maxLength format default optional readonly createonly queryable sortable
boolean no no no yes no

created

The date that this object was created.

type maxLength format default optional readonly createonly queryable sortable
string 20 date-time yes yes no yes no

updated

The date this object was last updated.

type maxLength format default optional readonly createonly queryable sortable
string 20 date-time yes yes no yes no

object_type

The type of the object.

type maxLength format default optional readonly createonly queryable sortable
string 32 yes yes no no no

Relationships

Package Key

A Method Override has one and only one related Package Key object. The related Package Key object can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, package_key from method_overrides.

Plan Method

A Method Override one and only one related Plan Method object. The related Plan Method objects can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, plan_method from method_overrides.

Object Methods

The method_override namespace contains the following methods for manipulating services.

method_override.fetch
Get a specific method override or a list of method overrides  .
method_override.delete
Delete a method override  .
method_override.create
Create a method override  .
method_override.validate
Validate a method override  .
method_override.update
Update a method override  .

Docs Navigation