key.fetch

Description

Fetch a single key object.  Please see Fetching Objects for an overview of how the fetch method works.

Parameters

key id

An integer representing the unique id of the key to fetch.  You may also pass a json object with a field of id to identify the key you wish to fetch.

Response

An key object, as described by the object.describe call. NULL is returned if the member could not be found.

Examples

A Sample JSON-RPC Key Fetch Request

{
    "method": "key.fetch",
    "params": [339],
    "id": 1
}

An alternative equivelant JSON-RPC Key Fetch Request

{
    "method": "key.fetch",
    "params": [{"service_key":"example_service_key", "apikey":"example_apikey"}],
    "id": 1
}

The JSON-RPC Response

{
    "result": {
        "id": 339,
        "created": "2009-12-04T21:34:46Z",
        "updated": "2009-12-04T21:34:46Z",
        "service_key": "example_service_key",
        "apikey": "example_apikey",
        "username": "example_username",
        "status": "waiting",
        "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.fetch 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.fetch may also return these errors: