HTTP Response Codes
Uprock APIs rely on standard HTTP status codes to indicate the outcome of API requests, enabling developers to handle successes and errors programmatically.
-
2xx responses indicate a successful request.
-
4xx responses indicate a client-side error, such as missing or invalid parameters.
-
5xx responses indicate an internal server error.
Additional details for each code are described below.
Success Responses (2xx)
| HTTP Status Code | Message | Description |
|---|---|---|
| 200 | OK | Request completed successfully. Returns the requested resource or confirmation. |
| 202 | Accepted | Request accepted but processing is incomplete. Retry the request shortly. |
| 201 | Created | Resource successfully created |
| 204 | No Content | Request succeeded, no body returned |
201 Created Resource successfully created (for example, after a POST). 204 No Content Request succeeded, no body returned (for example, after a DELETE).
Client Error Responses (4xx)
| HTTP Status Code | Message | Description |
|---|---|---|
| 400 | Bad Request | The request was invalid or could not be understood. Check your request parameters, and request body format |
| 401 | Unauthorized | Authentication has failed or required. Verify your API key is valid and properly formatted in the Authorization header`. |
| 404 | Not Found | The requested resource was not found. |
Server Error Responses (5xx)
| HTTP Status Code | Message | Description |
|---|---|---|
| 500 | Internal Server Error | An unexpected error occurred on the server |
| 502 | Bad Gateway | Received an invalid response from an upstream server |
| 503 | Service Unavailable | The server is currently unavailable, due to maintenance or overload |
| 504 | Gateway Timeout | The server did not receive a timely response from an upstream service |
Need Help?
If you encounter persistent errors or need assistance, contact support at support@uprock.com.
API Overview
Previous Page
Start a new crawl job POST
Starts a new job to crawl a URL with the specified parameters. The job will be scheduled for execution on an appropriate device based on the requested capabilities and placement constraints. After submitting a job, use the Get Job Status endpoint to track its progress and retrieve results when completed.