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

Changes the debug mode setting for the specified API implementation.

Authorization Roles/Permissions: Must be logged in. Must have Modify permission for the resource. API Admin, Business Admin, or other authorized Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

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

Sample Request

The example below shows a request to turn on debug mode for the specified API implementation by setting the logging level to 1.

Sample Request URL

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

Sample request headers

PUT /api/apis/versions/8fff41fb-1dcf-4843-95d2-d96b5d41c956.acmepaymentscorp/implementations/Live/debug HTTP/1.1
Host: api-mysql.local.acmepaymentscorp.com
Accept: application/vnd.soa.v84+json
Content-Type: application/vnd.soa.v84+json
X-Csrf-Token_acmepaymentscorp: TokenID%3Ddb1fd7bb-2b73-11e7-a793-8b0e7bb6d150%2CexpirationTime%3D1493318025629%2CUserFDN%3D1865e21f-7
ba5-4fdb-93ed-caaf45956f01%252Eacmepaymentscorp%2Csig%3DfhUvb7rSfF8WiN367HbI2xCc0KKuQ2m_9jjOvc0ZuWwcG7FoQPnETjZMMWNBi-7ZQGfPwY4cWZoWz
VT4IuFQahPOPjzpH__V4fNZP4Vmmuo8Wn9tjCMPcrpoXqYV79_FeNINaigSL053zlUb_52bxAkOgQMa9mxiBDMz0HuPMkmDWzKO92vkYxB0rpsU1FxJE9Dnb633NfW3Kq0hT-
TkAldvoSdlqH0eq_WJK0SBNpwm5sy5SJzM4BiBw5pSJ5UpHGipO_i4wbhu4XsPmX6bNfFJbp7htYKMeZj48efthEHS5H-tMS-Zet-67FYRCywGK_9PUQ_EmqsSnNJYbG9McQ

Sample request body

{
  "LogLevel":1
}

Request Headers

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

Header	Description
Accept	application/json, application/vnd.soa.v84+json
Content-Type	application/json, application/vnd.soa.v84+json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

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.
DebugMode	Body	DebugMode	Required	Contains information about the logging level of a specific API implementation; indicates whether debug mode is turned on or off.

Response

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

Sample Response

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

Sample response headers: application/vnd.soa.v84+json

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

Sample response body: application/vnd.soa.v84+json

{
  "LogLevel" : 1
}

Response Headers

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

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

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.

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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
405	Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics