key.update

Description

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

Parameters

key

An key object, as described by the object.describe call.  If a field in the 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 key object, as described by the object.describe call.  This is actual key that was updated.

Examples

This example updates the status of the key created in the key.create example to be active.

A Sample JSON-RPC Key Update Request

{
    "method": "key.update",
    "params": [
        {
            "id": 339,
            "status": "active"
        }
    ],
    "id": 1
}

The JSON-RPC Response

{
    "result": {
        "id": 339,
        "created": "2009-12-04T21:34:46Z",
        "updated": "2009-12-04T21:36:23Z",
        "service_key": "example_service_key",
        "apikey": "example_apikey",
        "username": "example_username",
        "status": "active",
        "rate_limit_ceiling": 0,
        "qps_limit_ceiling": 0,
        "rate_limit_exempt": false,
        "qps_limit_exempt": false,
        "required_referer": "",
        "secret": "",
        "limits": [
            {
                "period": "second",
                "source": "service",
                "ceiling": 2
            },
            {
                "period": "day",
                "source": "service",
                "ceiling": 5000
            }
        ],
        "object_type": "key"
    },
    "error": null,
    "id": 1
}

Permissions Required

The user who owns the key used to authenticate the 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, key.update may also return these errors: