uAPI error codes

The API key was not found or is incorrect. The provided API key does not exist in the system. This usually means the key was mistyped, deleted, or a non-existent value is being used.

The API key exists but is disabled. The key was found in the system but is inactive and cannot be used to execute requests.

You are requesting a URL that does not support the HTTP method used (GET, POST, DELETE, or PUT).

To fix this error, open the module settings in the site Control Panel (/admin) and enable “Enable uAPI for module”.

Your token is temporarily blocked: the hourly request limit was reached. See uAPI limits for details.

The request does not include all required parameters. The list for each method is given in the uAPI documentation.

The request was rejected because data does not match module rules. The response includes a num field with the specific reason number (see the response schema in Swagger for the corresponding method).

Pages module (POST /pages, PUT /pages): num: 2 — when owntmpl=1, a non-empty custom template body (tmpl) was sent, but the markup is missing the required $POWERED_BY$ placeholder. See the tmpl field description on the Pages module documentation page.

You are using an invalid Consumer Key. Check it on the uAPI panel page.

Signature generation failed. Possible causes: incorrect Token secret; wrong parameter sorting when building the signature; missing urlencode or base64 step.

You are using a token that does not exist. To create a token, go to the uAPI panel.

The nonce value you sent was already used. nonce must be unique for each request.

Possible causes: you are using a uID user token that was deleted, or the uID.me authorization service is temporarily unavailable.

Invalid verification code. The code is issued after you confirm app access to your data in the application. The issue is often caused by copying the code incorrectly from the browser address bar.

In the signed request, oauth_version (or another OAuth parameter) appears more than once. Each OAuth parameter must appear only once in the request.

An invalid token is being used. Check it on the uAPI panel page.