GET /api/apis/versions/{APIVersionID}/implementations/{ImplCode}/debug

Returns information about the debug mode setting for the specified API implementation.

Authorization Roles/Permissions: Must be logged in, and must have Read permission for the API information.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/implementations/{ImplCode}/debug

Back to top

Sample Request

The example below shows a request for debug mode information about the specified API implementation.

Request URL

https://{hostname}/api/apis/versions/8fff41fb-1dcf-4843-95d2-d96b5d41c956.automation/implementations/Live/debug

Sample request headers

Host: api-mysql.local.acmepaymentscorp.com
Accept: application/vnd.soa.v84+json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/xml, application/vnd.soa.v84+json, application/vnd.soa.v84+xml
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path String Required The unique ID for a specific API version.
ImplCode Path string Required A code for a specific implementation. Valid values: Live or Sandbox.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the debug logging level for the API implementation.

Back to top

Sample Response

The sample response below shows successful completion of this operation. The logging level is 1, which means that debug mode is turned on.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/vnd.soa.v84+json
Date: Thu, 27 Apr 2017 18:50:55 GMT

Sample response body: application/json

{
  "LogLevel" : 1
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/xml, application/vnd.soa.v84+json, application/vnd.soa.v84+xml

Back to top

Response Body

Name Type Description
DebugMode DebugMode Contains information about the logging level of a specific API implementation; indicates whether debug mode is turned on or off.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics