DELETE /api/apis/versions/{APIVersionID}/viewers/{ViewerID}

Removes the connection between a viewer (group) and a private API. The viewer (group) will no longer have access to the Private API and cannot see it once the connection is removed.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the API; an API Admin or Business Admin.

Metadata indexing: When this operation is run successfully, the platform metadata is automatically reindexed. Since the API documentation might include a metadata.xml file that directs visibility, the index must be updated when the API documentation resources are updated, to ensure the correct API documentation visibility settings are implemented.

This topic includes the following sections:

HTTP Method


Back to top



Back to top

Sample Request

The example below shows a request to remove the specified group's connection to the specified Private API.

Request URL


Sample request headers

DELETE /api/apis/versions/apiversion19184.acmepaymentscorp/viewers/group18691.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: text/plain, */*; q=0.01

Sample request body


Back to top

Request Headers

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

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type Any format (*/*)
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.
ViewerID Path string Required TheID of the viewer (group) for which the connection to the Private API is being removed.

Back to top


If successful, this operation returns HTTP status code 200. There is no response content.

Back to top

Sample Response

The sample response below shows confirmation that the action completed successfully.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 15 Feb 2013 14:44:34 GMT

Sample response body


Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body


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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.

The resource could not be found.

For example, you might get this if the Accept header is set to a wrong value.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics