error-response-format-77fef2f.md

Error Response Format

Describes the response format for the errors from the SAP Cloud Management service for SAP BTP.

Standard HTTP codes are used to indicate successful execution or if errors occur. The response includes additional information about the error, including an application error code and human readable error description. This example represents a common error response resulting from a failed API request.

HTTP/1.1 400 Bad Request
{
  "error": {
    "code": 11000,
    "message": "Request payload is invalid",
    "target": "/accounts/v1/subaccounts/125e2778-e457-4c24-9db8-e3e10a3a0ed5",
    "details": [
      {
        "code": 11001,
        "message": "description: length must be between 0 and 255"
      }
    ]
  }
}

Parameter	Description	Type
error.code	A unique application error code. Common values are listed below.	Number
error.message	A description of the error.	String
error.target	The resource URL of the request.	String
error.details	An array of additional error codes and descriptions with further details about the error and its root cause. If this field exists, the array will contain at least one element.	Array

An application error code is not necessarily coupled with a specific HTTP status code.

Error Codes

Provides a list of error codes and the details of the errors.

Error Code	Description
10XXX	Server errors
11XXX	General request errors
12XXX	General operations failures
2XXXX	Accounts service errors
3XXXX	Entitlements service errors
40XXX	Tenants operations failures
41XXX	Environment instances operations failures
42XXX	Provisioning service errors
5XXXX	Service Management service proxy errors
6XXXX	Order Processing service errors
7XXXX	CLI backend errors
8XXXX	Asynchronous jobs failures
9XXXX	SaaS Provisioning service errors
10XXXX	Events service errors