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

Modifies the policy assignments for the specified implementation for the specified API version.

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

This topic includes the following sections:

HTTP Method

PUT

URL

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

Sample Request

The example below shows a request to modify which policies are assigned to the specified implementation for the specified API version.

Sample Request URL

https://{hostname}/api/apis/versions/4a1a513f-2758-48a9-8103-d869793e2ac8.acmepaymentscorp/implementations/Live/policies

Sample request headers

Accept: application/json
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
    "Policy": [
        {
            "PolicyKey": "acmepaymentscorp-AtmosphereApplicationSecurityPolicy",
            "Name": "AtmosphereApplicationSecurityPolicy",
            "Description": "",
            "PolicyType": "Operational Policy",
            "PolicySubType": "policy.apisec"
        }
    ],
    "ApiOperationPolicy": [
        {
            "Operation": {
                "Name": "addPet",
                "Method": "POST",
                "Path": "/pet",
                "InputContentType": "application/xml,application/json",
                "OutputContentType": "application/xml,application/json",
                "FaultContentType": "",
                "Input": [
                    {
                        "Name": "body",
                        "Type": "entity"
                    }
                ],
                "OperationKey": "4f30020e-5304-4f6e-a9cb-8a986caecde8",
                "InterfaceQName": "{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
                "WsdlOperationName": "addPet"
            },
            "Policy": [
                {
                    "PolicyKey": "acmepaymentscorp-DetailedAuditing",
                    "Name": "DetailedAuditing",
                    "Description": "",
                    "PolicyType": "Operational Policy",
                    "PolicySubType": "policy.auditservice"
                }
            ]
        },
        {
            "Operation": {
                "Name": "findPetsByStatus",
                "Method": "GET",
                "Path": "/pet/findByStatus",
                "InputContentType": "",
                "OutputContentType": "application/xml,application/json",
                "FaultContentType": "",
                "Input": [
                    {
                        "Name": "status",
                        "Type": "query"
                    }
                ],
                "OperationKey": "d45d2614-9f22-4cc0-893e-10c0b4338d5f",
                "InterfaceQName": "{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
                "WsdlOperationName": "findPetsByStatus"
            }
        }
    ]
}

Request Headers

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

Header	Description
Accept	application/json, application/vnd.soa.v81+json
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/vnd.soa.v81+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.
ApiPolicies Valid in version: 2020.0.0 and later	Body	ApiPolicies	Required	Contains information about the policies assigned to an API or API implementation. Note: In versions prior to 2020.2.0, this operation used the Policies model object.

Response

If successful, this operation returns HTTP status code 200, with the updated policy information for the API version implementation.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Fri, 20 Nov 2020 14:24:40 GMT

Sample response body: application/json

{
  "Policy": [
    {
      "PolicyKey": "acmepaymentscorp-AtmosphereApplicationSecurityPolicy",
      "Name": "AtmosphereApplicationSecurityPolicy",
      "Description": "",
      "PolicyType": "Operational Policy",
      "PolicySubType": "policy.apisec"
    }
  ],
  "ApiOperationPolicy": [
    {
      "Operation": {
        "Name": "addPet",
        "Method": "POST",
        "Path": "/pet",
        "InputContentType": "application/xml,application/json",
        "OutputContentType": "application/xml,application/json",
        "FaultContentType": "",
        "Input": [
          {
            "Name": "body",
            "Type": "entity"
          }
        ],
        "OperationKey": "4f30020e-5304-4f6e-a9cb-8a986caecde8",
        "InterfaceQName": "{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
        "WsdlOperationName": "addPet"
      },
      "Policy": [
        {
          "PolicyKey": "acmepaymentscorp-DetailedAuditing",
          "Name": "DetailedAuditing",
          "Description": "",
          "PolicyType": "Operational Policy",
          "PolicySubType": "policy.auditservice"
        }
      ]
    },
    {
      "Operation": {
        "Name": "findPetsByStatus",
        "Method": "GET",
        "Path": "/pet/findByStatus",
        "InputContentType": "",
        "OutputContentType": "application/xml,application/json",
        "FaultContentType": "",
        "Input": [
          {
            "Name": "status",
            "Type": "query"
          }
        ],
        "OperationKey": "d45d2614-9f22-4cc0-893e-10c0b4338d5f",
        "InterfaceQName": "{Swagger_Petstore_5_Operations_v1}Swagger_Petstore_5_Operations_PortType_0",
        "WsdlOperationName": "findPetsByStatus"
      }
    }
  ]
}

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

Response Body

Name	Type	Description
ApiPolicies Valid in version: 2020.0.0 and later	ApiPolicies	Contains information about the policies assigned to an API or API implementation. Note: In versions prior to 2020.2.0, this operation used the Policies model object.

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.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics