package_key.update

Description

Update a package key  Please see Updating Objects for an overview of how the update method works.

NOTE:This method 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.

Parameters

package_key

An package_key object, as described by the object.describe call. If a field in the package_key object is ommitted, no change will be made to that field. If extra fields are passed, they will be ignored. The primary identifier must be specified.

Response

An package_key object, as described by the object.describe call. This is actual package_key that was updated.

Examples

A Sample JSON-RPC package_key.update Request

{
    "method":"package_key.update",
    "id":35,
    "params":[{"id":35,
    "plan":{"id":47},
    "qps_limit_exempt":false,
    "qps_limit_ceiling":4,
    "rate_limit_exempt":false,
    "rate_limit_ceiling":500}]
}

The JSON-RPC Response

{
"result": true,
"error": null,
"id": 1}

Permissions Required

The user who owns the key used to authenticate the package_key.update call must be a member of one of the following roles

•  
  • Administrator
  • Program Manager
  • Community Manager

See authentication.

Errors

In addition to the standard json-rpc errors and authentication errors, application.fetch may also return these errors: