Status Code Definitions

2xx

Received, understood, and accepted a request.

3xx

The user agent must take further action in order to complete the request.

4xx

An error occurred in handling the request. The most common cause of this error is an invalid parameter.

5xx

Received and accepted the request, but an error occurred in the T-Mobile service while handling it.

200

success

The request was successful.

201

created

The request was successful and the resource was created.

202

accepted

The request has been accepted for processing, but has not yet been completed.

204

no_content

The request was successful, but the client does not need to navigate away from the current page.

302

redirect

The resource has moved.

304

not_modified

The request has not changed since the last time it was accessed.

400

bad_request

Invalid/missing data.

401

unauthorized

Invalid/missing credentials.

403

forbidden, access_denied

Client does not have access to the requested resource.

404

not_found

The resource doesn't exists, ex. invalid/non-existent user id.

405

method_not_allowed

Method not supported by the target.

409

conflict

Trying to overwrite a resource, ex. when creating a user with an email that already exists.

412

precondition_failed

Access denied. The client has failed a precondition.

415

unsupported_media_type

Payload format not supported.

429

too_many_requests

The number of requests exceeds rate limit.

500

internal_server_error

Internal server error.

501

not_implemented

The server does not have the requested resource or method implemented.

502

bad_gateway

Bad Gateway

503

service_unavailable

Server is unavailable.

504

gateway_timeout

Gateway did not get a response in time

code

string

HTTP status code.

userMessage

string

A human-readable message describing the error.

systemMessage

string

Text that provides a more detailed technical explanation of the error.

detailLink

string

Link to custom information providing greater detail on error(s).

200

OK / Success

Success. The API call was successful.

201

Created

The request has succeeded and a new resource has been created as a result. This is typically the response sent after POST requests or some PUT requests.

204

No Content

There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones.

401
(Unauthorized)

Invalid Access Token

This error occurs when the access token sent by the client is not valid.

{
  "code": "Security-1001"
  "userMessage": "Invalid Access Token"
  "systemMessage": "Invalid Access Token"
}

Invalid API Key

An API key was received by Edge, but it is invalid. When Edge looks up the key in its database, it must exactly match the one that was sent in the request. If the API worked previously, make sure the key was not regenerated. If the key was regenerated, you will see this error if you try to use the old key. For details, see Register apps and manage API keys

{
  "code": "Security-1008"
  "userMessage": "Invalid API Key"
  "systemMessage": "Invalid API Key"
}

Invalid API Key For Given Resource

An API key was received by Edge, and it is valid; however, it does not match an approved key in the Developer App associated with your API proxy through a Product.

{
  "code": "Security-1009"
  "userMessage": "Invalid Api Key For Given Resource"
  "systemMessage": "Invalid Api Key For Given Resource"
}

Invalid PoP Token

This error occurs when the value of the PoP token sent in the X-Authorization header is expired.

{
  "code": "Security-1017"
  "userMessage": "X-Authorization: Invalid PoP Token"
  "systemMessage": "X-Authorization: Invalid PoP Token"
}

403
(Forbidden)

IP Denied Access

The client IP address, or an IP address passed as part of the X-Forwarded-For HTTP header in the API request, matches an IP address specified in the <SourceAddress> element within the <MatchRule> element of the Access Control Policy, and the action attribute of the <MatchRule>element is set to DENY.

{
  "code": "Security-1013"
  "userMessage": "Access to API denied from the requested IP address"
  "systemMessage": "Access to API denied from the requested IP address"
}

406
(Not Acceptable)

Fault Not Acceptable

This error occurs when the request.verb is not equal to options and request.header. Accept is not equal to application/xml, application/json, and text/xml

{
  "code": "SECURITY-0018"
  "userMessage": "Accept Type not supported"
  "systemMessage": "The Accept type set in request header is not supported"
}

429
(Too Many
Requests)

Quota Violation

The quota limit was exceeded.

{
  "code": "Traffic-1004"
  "userMessage": "The quota limit is exceeded"
  "systemMessage":"The quota limit is exceeded"
}

429
(Too Many
Requests)

Spike Arrest Violation

The rate limit was exceeded.

{
  "code": "Traffic-1001"
  "userMessage": "The rate limit is exceeded"
  "systemMessage":"The rate limit is exceeded"
}

500
(Internal
Server
Error)

General

The 500 Internal Server Error could be thrown due to a number of different causes. For further details and troubleshooting steps, please refer to this documentation.

{
  "code": "Traffic-1007",
  "userMessage": "Internal Server Error",
  "systemMessage": "Internal Server Error"
}

Failed To Resolve Quota Interval Reference

Occurs if the <Interval> element is not defined within the Quota policy.

{
  "code": "Traffic-1007"
  "userMessage": "Internal Server Error"
  "systemMessage": "Internal Server Error"
}

Failed To Resolve Quota Interval Time Unit Reference

Occurs if the <TimeUnit> element is not defined within the Quota policy.

{
  "code": "Traffic-1008"
  "userMessage": "Internal Server Error"
  "systemMessage": "Internal Server Error"
}

Failed To Resolve Spike Arrest Rate

This error occurs if the reference to the variable containing the rate setting within the <Rate> element cannot be resolved to a value within the Spike Arrest policy. This element is mandatory and used to specify the spike arrest rate in the form of {int}pm or {int}ps.

Error creating object
Invalid spike arrest rate 300ph.

501
(Not
Implemented)

Unknown Resource

This type of error occurs when none of the conditional flows are matched. The server does not support the functionality required to fulfill the request.

{
  "code": "SECURITY-0017",
  "userMessage": "Requested Resource or Method is not implemented",
  "systemMessage": "ERROR_SOURCE:API; Requested Resource or Method is not implemented"
}

502
(Bad
Gateway)

Bad Gateway

This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response. For further details and troubleshooting steps, please refer to this documentation.

Bad Gateway Timeout

The Message Processor returns this error to the client application when it does not receive a response from a backend server. For further details and troubleshooting steps, please refer to this documentation.

Bad Gateway Unexpected EOF

The HTTP status code 502 means that the client is not receiving a valid response from the backend servers that should actually fulfill the request. For further details and troubleshooting steps, please refer to this documentation.

503
(Service
Unavailable)

Service Unavailable

The HTTP response 503 Service Unavailable with the error code messaging.adaptors.http.flow.ServiceUnavailable occurs if the Apigee Edge’s Message Processor experiences errors due to connection time out, incorrect host name, or SSL handshake failures while communicating with the backend server.

Additional details and troubleshooting steps here.

Service Unavailable - Backend Server

The HTTP status code 503 means that the server is currently unable to handle the incoming requests. Usually, this error occurs because the server is too busy or is temporarily down for maintenance.

Additional details and troubleshooting steps here.

Service Unavailable - No Active Targets

The HTTP response 503 Service Unavailable with the error code NoActiveTargets is typically observed when you use one or more target servers in the target endpoint configuration in your API Proxy.

Additional details and troubleshooting steps here.

504
(Gateway
Timeout)

Gateway Timeout

The HTTP status code - 504 Gateway Timeout error indicates that the client did not receive a timely response from the Edge Gateway or backend server during the execution of an API.

Additional details and troubleshooting steps here.

{
    "errors": [
        {
            "reasonCode": "ERR-1063",
            "systemMessage": "Internal Server Error",
            "userMessage": "APIkey provided is invalid"
        }
    ]
}

• The "Basic" Authorization OAuth 2.0 token was not properly Base64 encoded. Check your client_id and client_secret and see if there were any spaces or carriage returns when you base64 encoded it. Read the document Step 1: Generate PoP Token - OAuth 2.0 to learn more.

{
    "fault": {
        "faultstring": "Raising fault. Fault name : cf_Invalid_PoP_Token",
        "detail": {
            "errorcode": "steps.raisefault.RaiseFault"
        }
    }
}

• Your PoP Token has expired.
• Your header API call does not contain the Content-Type = application/json in it. Check to make sure your API header contains the correct Content-Type .

{
    "errors": [
        {
            "reasonCode": "ERR-1005",
            "systemMessage": "Unauthorized",
            "userMessage": "Invalid token type or missing token"
        }
    ]
}

• Your Authorization token is invalid. Check to make sure that the Authorization token is a "Basic" token and was properly base64 encoded if it is the OAuth 2.0 PoP Token.
• If it is an API Resource Token, check to make sure the Authorization token is a "Bearer" token and uses the OAuth 2.0 access token.

{
    "fault": {
        "faultstring": "Raising fault. Fault name : RF-Missing_XAuth_Headers",
        "detail": {
            "errorcode": "steps.raisefault.RaiseFault"
        }
    }
}

• Check to make sure your PoP Token is included in your header.

{
    "errors": [
        {
            "reasonCode": "ERR-1000",
            "systemMessage": "Server Error",
            "userMessage": "Server Error"
        }
    ]
}

• An attempt was made to try and create a resource (via a POST) that was already in existence. Try sending a GET request to see if the resource already exists. If desired, you may update the existing record by sending a PUT request.

{
    "errors": [
        {
            "reasonCode": "ERR-1091",
            "systemMessage": "Unauthorized",
            "userMessage": "Token Expired"
        }
    ]
}

• Read the Step 2: Generate OAuth 2.0 Access and ID Tokens to understand how to create an access token.

{
    "errors": [
        {
            "reasonCode": "ERR-1066",
            "systemMessage": "Internal Server Error",
            "userMessage": "Failed to resolve API Key"
        }
    ]
}