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

Updates information about the header propagation settings assigned to a specified implementation for a given 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
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

PUT

URL

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

Sample Request

The following example shows a request to modify the header settings for a specific API operation.

Sample request URL

https://{hostname}/api/apis/versions/51e497c0-a68e-4c19-ab16-9514c71ffcfa/implementations/Live/headersettings

Sample request headers

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

Sample request body # 1

{
	"ApiOperationHeaderSettings": [
		{
			"Operation": {
				"WsdlOperationName": "addPet"
                        },
			"BindingHeaderInstructions": {
				"PreservedBindingHeader": [
				    {
				       "otherAttributes": {},
				       "Namespace": "http://example.com/ns1",
				       "Name": "TrackingHeader"
				    },
				    {
				       "otherAttributes": {},
				       "Namespace": "http://example.com/ns2",
				       "Name": "TrackingHeader"
				    },
				    {
				       "otherAttributes": {},
				       "Namespace": "http://example.com/ns3",
				       "Name": "CustomHeader"
				    }
				]
		 },
		 "TransportHeaderInstructions": {
			  "PreservedTransportHeader": [
				 "X-CUSTOM-HEADER1",
				 "X-CUSTOM-HEADER2"
			 ]
		  }
	  }
   ]
}

Sample request body # 2

{
	"ApiOperationHeaderSettings": [
		{
			"Operation": {
				"WsdlOperationName": "getInventory"
			}
			,
			"BindingHeaderInstructions": {
				"PreserveBindingHeaders": true
			},
			"TransportHeaderInstructions": {
				"PreserveTransportHeaders": true
			}
		}
	]
}

Sample request body # 3

The following example shows a request to modify the header settings for multiple operations.

{
	"ApiOperationHeaderSettings": [
		{
			"Operation": {
				"WsdlOperationName": "addPet"
			},
			"TransportHeaderInstructions": {
				"PreservedTransportHeader": []
			},
			"BindingHeaderInstructions": {
				"PreservedBindingHeader": [
				    {
				       "otherAttributes": {},
				 	   "Namespace": "http://example.com/ns1",
				       "Name": "CustomHeader"
				    },
				    {
				       "otherAttributes": {},
				       "Namespace": "http://example.com/ns1",
				       "Name": "CustomHeader1"
				    },
				    {
				       "otherAttributes": {},
				       "Namespace": "http://example.com/ns2",
				       "Name": "TrackingHeader"
				    },
				    {
				       "otherAttributes": {},
				       "Namespace": "http://example.com/ns3",
				       "Name": "CustomHeader"
				    }
				]
			}
		},
		{
			"Operation": {
				"WsdlOperationName": "getInventory"
		}
		,
		"BindingHeaderInstructions": {
			"PreserveBindingHeaders": true
		},
		"TransportHeaderInstructions": {
			"PreserveTransportHeaders": true
		}
	  }
   ]
}

Request Headers

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

Header	Description
Accept	application/json, application/xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml
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.

Header

Description

application/json, application/xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

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.

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.
ApiOperationHeaderSettings	Body	ApiOperationHeaderSettings	Required	Contains information about the header settings assigned to a specified implementation for a specific API version.

Response

If successful, this operation returns HTTP status code 200 with information about the header settings assigned to the operations under API version implementation.

Sample Response

The sample responses below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type:  application/json
Date: Wed, 11 Aug 2025 19:47:26 GMT

Sample response body

{
	"ApiOperationHeaderSettings": [
		{
			"Operation": {
				"OperationKey": "896405cc-9836-41ca-865a-188a0441c295",
				"OperationId": 37323,
				"ServiceKey": "uddi:86b9362b-0ad6-402a-808b-b29f30125bb6",
				"OperationName": "addPet",
				"WsdlOperationName": "addPet",
				"InterfaceName": "{Swagger_Petstore_1.0.7}Swagger_Petstore_PortType_0_3425150_0_9316555",
				"Name": "addPet",
				"Method": "POST",
				"Path": "/pet",
				"InputContentType": "application/json,application/xml",
				"OutputContentType": "application/json,application/xml",
				"FaultContentType": ""
			},
			"BindingHeaderInstructions": {
				"PreservedBindingHeader": [
				   {
				     "otherAttributes": {},
				     "Namespace": "http://example.com/ns1",
				     "Name": "TrackingHeader"
				  },
				  {
				     "otherAttributes": {},
				     "Namespace": "http://example.com/ns2",
				     "Name": "TrackingHeader"
				  },
				  {
				     "otherAttributes": {},
				     "Namespace": "http://example.com/ns3",
				     "Name": "CustomHeader"
				  }
			]
		},
		"TransportHeaderInstructions": {
			"PreservedTransportHeader": [
				"X-CUSTOM-HEADER1",
				"X-CUSTOM-HEADER2",
			]
		}
		},
		{
			"Operation": {
				"OperationKey": "c2d7ef73-a5db-4323-b9d8-71a98ad0b1e5",
				"OperationId": 37333,
				"ServiceKey": "uddi:86b9362b-0ad6-402a-808b-b29f30125bb6",
				"OperationName": "createUser",
				"WsdlOperationName": "createUser",
				"InterfaceName": "{Swagger_Petstore_1.0.7}Swagger_Petstore_PortType_0_3425150_0_9316555",
				"Name": "createUser",
				"Method": "POST",
				"Path": "/user",
				"InputContentType": "application/json",
				"OutputContentType": "application/json,application/xml",
				"FaultContentType": ""
			},
			"BindingHeaderInstructions": {
				"PreservedBindingHeader": [
				   {
				     "otherAttributes": {},
				     "Namespace": "http://example.com/ns1",
				     "Name": "TrackingHeader"
				  },
				  {
				     "otherAttributes": {},
				     "Namespace": "http://example.com/ns2",
			 	     "Name": "TrackingHeader"
				  },
				  {
				     "otherAttributes": {},
				     "Namespace": "http://example.com/ns3",
				     "Name": "CustomHeader"
				  }
			]
		},
		"TransportHeaderInstructions": {
			"PreservedTransportHeader": [
				"X-CUSTOM-HEADER1",
				"X-CUSTOM-HEADER2",
			]
		}
	},
	{
		"Operation": {
			"OperationKey": "9667c936-6d87-4223-91b0-641e80cb88ac",
			"OperationId": 37334,
			"ServiceKey": "uddi:86b9362b-0ad6-402a-808b-b29f30125bb6",
			"OperationName": "createUsersWithArrayInput",
			"WsdlOperationName": "createUsersWithArrayInput",
			"InterfaceName": "{Swagger_Petstore_1.0.7}Swagger_Petstore_PortType_0_3425150_0_9316555",
			"Name": "createUsersWithArrayInput",
			"Method": "POST",
			"Path": "/user/createWithArray",
			"InputContentType": "application/json",
			"OutputContentType": "application/json,application/xml",
			"FaultContentType": ""
		},
		"BindingHeaderInstructions": {
			"PreservedBindingHeader": [
				{
				   "otherAttributes": {},
				   "Namespace": "http://example.com/ns1",
				   "Name": "TrackingHeader"
				},
				{
				   "otherAttributes": {},
				   "Namespace": "http://example.com/ns2",
				   "Name": "TrackingHeader"
				},
				{
				   "otherAttributes": {},
				   "Namespace": "http://example.com/ns3",
				   "Name": "CustomHeader"
				}
			]
		},
		"TransportHeaderInstructions": {
			"PreservedTransportHeader": [
				"X-CUSTOM-HEADER1",
				"X-CUSTOM-HEADER2",
			]
		}
	},
	{
		"Operation": {
			"OperationKey": "ed1a9f4f-bac9-4502-90aa-76b6730569bd",
			"OperationId": 37330,
			"ServiceKey": "uddi:86b9362b-0ad6-402a-808b-b29f30125bb6",
			"OperationName": "getUserByName",
			"WsdlOperationName": "getUserByName",
			"InterfaceName": "{Swagger_Petstore_1.0.7}Swagger_Petstore_PortType_0_3425150_0_9316555",
			"Name": "getUserByName",
			"Method": "GET",
			"Path": "/user/{username}",
			"InputContentType": "",
			"OutputContentType": "application/json,application/xml",
			"FaultContentType": ""
		},
		"BindingHeaderInstructions": {
			"PreservedBindingHeader": [
				{
				   "otherAttributes": {},
				   "Namespace": "http://example.com/ns1",
				   "Name": "TrackingHeader"
				},
				{
				   "otherAttributes": {},
				   "Namespace": "http://example.com/ns2",
				   "Name": "TrackingHeader"
				},
				{
				   "otherAttributes": {},
				   "Namespace": "http://example.com/ns3",
				   "Name": "CustomHeader"
				}
			]
		},
		"TransportHeaderInstructions": {
			"PreservedTransportHeader": [
				"X-CUSTOM-HEADER1",
				"X-CUSTOM-HEADER2",
			]
		}
	},
	{
		"Operation": {
			"OperationKey": "789b270d-ca36-4e97-893f-3546017776fb",
			"OperationId": 37321,
			"ServiceKey": "uddi:86b9362b-0ad6-402a-808b-b29f30125bb6",
			"OperationName": "uploadFile",
			"WsdlOperationName": "uploadFile",
			"InterfaceName": "{Swagger_Petstore_1.0.7}Swagger_Petstore_PortType_0_3425150_0_9316555",
			"Name": "uploadFile",
			"Method": "POST",
			"Path": "/pet/{petId}/uploadImage",
			"InputContentType": "multipart/form-data",
			"OutputContentType": "application/json",
			"FaultContentType": ""
		},
		"BindingHeaderInstructions": {
			"PreservedBindingHeader": [
				{
				   "otherAttributes": {},
				   "Namespace": "http://example.com/ns1",
				   "Name": "TrackingHeader"
				},
				{
				   "otherAttributes": {},
				   "Namespace": "http://example.com/ns2",
				   "Name": "TrackingHeader"
				},
				{
				   "otherAttributes": {},
				   "Namespace": "http://example.com/ns3",
				   "Name": "CustomHeader"
				}
			]
		},
		"TransportHeaderInstructions": {
			"PreservedTransportHeader": [
				"X-CUSTOM-HEADER1",
				"X-CUSTOM-HEADER2",
			]
		 }
	 }
  ]
}

Response Headers

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

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

Response Body

Name	Type	Description
ApiOperationHeaderSettings	ApiOperationHeaderSettings	Contains information about the header settings for an API operation.

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
400	Bad request: Returned if the client sends a malformed request; for example, invalid parameters or body content.
401	Unauthorized. For example, you would get this response if you included an invalid or expired value for the header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404	The resource could not be found. For example, you might get this if you have a typo in the URL or incorrect parameter value in the URL.
406	Not Acceptable. Returned if there is a problem with the request format. For example, you would get this if you specified an incorrect media type for the Accept header.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.