GET /api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/policies

Returns information about the policies assigned to the specified implementation for the specified API version.

New in API Platform Version: 8.1

Authorization Roles/Permissions: Anyone can use this operation; login is not required. However, note that for any operations that do not require login, information about private resources is not returned unless the user is logged in and is authorized to view information about those resources. Without login, only public information is returned. Results are returned only if the user calling the operation has visibility of the API.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/versions/{ApiVersionID}/implementations/{ImplCode}/policies

Back to top

Sample Request

The example below shows a request for information about the policies assigned to the specified implementation for the specified API version. There are two policies assigned.

Request URL

https://{hostname}/api/apis/versions/16b3def3-f067-4ad5-b2b9-b143aa76beeb.acmepaymentscorp/implementations/Live/policies

Sample request headers

Accept: application/vnd.soa.v81+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/vnd.soa.v81+json
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.
IncludeImpliedPolicies Path Boolean Optional

If set to true, implied policies are also included in the response. These are policies that are assigned to ancestors. For example, policies assigned to the platform tenant will apply to all services. If this parameter is set to true, all policies assigned to services, including inherited policy assignments, are returned.

Default: false.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the policies assigned to the specified API version implementation.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

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

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+json
Date: Fri, 18 Mar 2016 02:01:15 GMT

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

{
  "Policy" : [ {
    "PolicyKey" : "Atmosphere-AtmosphereApplicationSecurityPolicy",
    "Name" : "AtmosphereApplicationSecurityPolicy",
    "Description" : "",
    "PolicyType" : "Operational Policy",
    "PolicySubType" : "policy.apisec"
  }, {
    "PolicyKey" : "Atmosphere-DetailedAuditing",
    "Name" : "DetailedAuditing",
    "Description" : "",
    "PolicyType" : "Operational Policy",
    "PolicySubType" : "policy.auditservice"
  } ]
}

Back to top

Response Headers

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

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

Back to top

Response Body

Name Type Description
Policies Policies Contains information about one or more policies that are enforced for the API version, if applicable.

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