PUT /api/businesses/{BusinessID}/apisettings
Updates the configurable API settings for a business on the platform.
Note: When you change a setting, it might take up to five minutes for the change to take effect.
Authorization Roles/Permissions: Site Admin.
This topic includes the following sections:
HTTP Method
PUT
URL
https://{hostname}/api/businesses/{BusinessID}/apisettings
Sample Request
The example below shows a request to update the default API settings for hte business.
Sample Request URL
https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/apisettings
Sample request headers
PUT /api/businesses/tenantbusiness.acmepaymentscorp/apisettings HTTP/1.1
Host: {hostname}
Accept: application/json
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
{
"APIWithNewServiceSupport": "com.soa.feature.enabled",
"APIWithExistingServiceSupport": "com.soa.feature.disabled",
"PrivateAPIGroupTypeSupport": "com.soa.feature.disabled",
"APIPromotionSupport": "com.soa.feature.enabled",
"ValidateUniqueContextPath": "com.soa.feature.enabled",
"ApiVersionWorkflowDefKey": "4c9de0a9-c5d3-4369-8956-fcb8facd8fea",
"PublicAPISupport": "com.soa.feature.enabled",
"PublicAPISandboxEndpointSupport": "com.soa.feature.enabled",
"PublicAPISandboxAutoApprovalSupport": "com.soa.feature.enabled",
"PublicAPIProductionEndpointSupport": "com.soa.feature.enabled",
"PublicAPIProductionAutoApprovalSupport": "com.soa.feature.enabled",
"PublicAPIRatingsSupport": "com.soa.feature.enabled",
"PublicAPIReviewsSupport": "com.soa.feature.enabled",
"PublicAPIResourceLevelPermissionsSupport": "com.soa.feature.enabled",
"PrivateAPISupport": "com.soa.feature.enabled",
"PrivateAPISandboxEndpointSupport": "com.soa.feature.enabled",
"PrivateAPISandboxAutoApprovalSupport": "com.soa.feature.enabled",
"PrivateAPIProductionEndpointSupport": "com.soa.feature.enabled",
"PrivateAPIProductionAutoApprovalSupport": "com.soa.feature.enabled",
"PrivateAPIIndependentGroupSupport": "com.soa.feature.enabled",
"PrivateAPIRatingsSupport": "com.soa.feature.enabled",
"PrivateAPIReviewsSupport": "com.soa.feature.enabled",
"PrivateAPIResourceLevelPermissionsSupport": "com.soa.feature.enabled"
}
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept |
application/json, application/xml application/vnd.soa.v71+json, application/vnd.soa.v71+xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml application/vnd.soa.v84+xml |
| Content-Type |
Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml application/vnd.soa.v84+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. |
| 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 |
|---|---|---|---|---|
| BusinessID | Path | string | Required | The unique ID for a specific business organization on the platform. |
| BusinessAPISettings | Body | BusinessAPISettings | Required | Contains information about the settings to apply to all APIs within the business, unless specified otherwise at a lower level. |
Response
If successful, this operation returns HTTP status code 200, with the updated settings.
Sample Response
The sample response below shows the updated API settings for the business.
Sample response headers: application/vnd.soa.v84+json
HTTP/1.1 200 OK Content-Type: application/vnd.soa.v84+json Date: Wed, 11 Mar 2020 14:35:52 GMT
Sample response body: application/json
{
"APIWithNewServiceSupport": "com.soa.feature.enabled",
"APIWithExistingServiceSupport": "com.soa.feature.disabled",
"PrivateAPIGroupTypeSupport": "com.soa.feature.disabled",
"APIPromotionSupport": "com.soa.feature.enabled",
"ValidateUniqueContextPath": "com.soa.feature.enabled",
"ApiVersionWorkflowDefKey": "4c9de0a9-c5d3-4369-8956-fcb8facd8fea",
"PublicAPISupport": "com.soa.feature.enabled",
"PublicAPISandboxEndpointSupport": "com.soa.feature.enabled",
"PublicAPISandboxAutoApprovalSupport": "com.soa.feature.enabled",
"PublicAPIProductionEndpointSupport": "com.soa.feature.enabled",
"PublicAPIProductionAutoApprovalSupport": "com.soa.feature.enabled",
"PublicAPIRatingsSupport": "com.soa.feature.enabled",
"PublicAPIReviewsSupport": "com.soa.feature.enabled",
"PublicAPIResourceLevelPermissionsSupport": "com.soa.feature.enabled",
"PrivateAPISupport": "com.soa.feature.enabled",
"PrivateAPISandboxEndpointSupport": "com.soa.feature.enabled",
"PrivateAPISandboxAutoApprovalSupport": "com.soa.feature.enabled",
"PrivateAPIProductionEndpointSupport": "com.soa.feature.enabled",
"PrivateAPIProductionAutoApprovalSupport": "com.soa.feature.enabled",
"PrivateAPIIndependentGroupSupport": "com.soa.feature.enabled",
"PrivateAPIRatingsSupport": "com.soa.feature.enabled",
"PrivateAPIReviewsSupport": "com.soa.feature.enabled",
"PrivateAPIResourceLevelPermissionsSupport": "com.soa.feature.enabled"
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type |
application/json, application/xml application/vnd.soa.v71+json, application/vnd.soa.v71+xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml application/vnd.soa.v84+xml |
Response Body
| Name | Type | Description |
|---|---|---|
| BusinessAPISettings | BusinessAPISettings |
Contains information about the settings to apply to all APIs within the business, unless specified otherwise at a lower level. The updated information is returned in the response. |
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.