APISettings Object
Includes information about the settings for an API; for example, whether access is auto approved and whether ratings and reviews are supported.
This object is used by the following operations:
- GET /api/apis/{APIID}/settings
- Operations that reference the API object
The properties included in the APISettings object are listed below.
| Property | Type | Description |
|---|---|---|
| PublicAPISupport | String | Indicates whether public API support is enabled or disabled. |
| PublicAPISandboxEndpointSupport | String | Indicates whether public API Sandbox endpoint support is enabled or disabled. |
| PublicAPIProductionEndpointSupport | String | Indicates whether public API Live endpoint support is enabled or disabled. |
| PublicAPISandboxAutoApprovalSupport | String | Indicates whether automatic approval of requests for access to the Sandbox implementation for a public API is enabled or disabled. |
| PublicAPIProductionAutoApprovalSupport | String | Indicates whether automatic approval of requests for access to the Live implementation for a public API is enabled or disabled. |
| PublicAPIBoardSupport | String | Indicates whether public API Board support is enabled or disabled. |
| PublicAPIRatingsSupport | String | Indicates whether public API ratings support is enabled or disabled. |
| PublicAPIReviewsSupport | String | Indicates whether public API review support is enabled or disabled. |
| PrivateAPISupport | String | Indicates whether Private API support is enabled or disabled. |
| PrivateAPISandboxEndpointSupport | String | Indicates whether Private API Sandbox endpoint support is enabled or disabled. |
| PrivateAPIProductionEndpointSupport | String | Indicates whether Private API Sandbox production support is enabled or disabled. |
| PrivateAPISandboxAutoApprovalSupport | String | Indicates whether automatic approval of requests for access to the Sandbox implementation for a Private API is enabled or disabled. |
| PrivateAPIProductionAutoApprovalSupport | String | Indicates whether automatic approval of requests for access to the Live implementation for a Private API is enabled or disabled. |
| PrivateAPIGroupTypeSupport | String | Indicates whether API Scope Group (Private API Group) support is enabled or disabled for the API. |
| PrivateAPIIndependentGroupSupport | String | Indicates whether independent group support is enabled or disabled. |
| PrivateAPIBoardSupport | String | Indicates whether Private API Board support is enabled or disabled. |
| PrivateAPIRatingsSupport | String | Indicates whether Private API ratings support is enabled or disabled. |
| PrivateAPIReviewsSupport | String | Indicates whether Private API review support is enabled or disabled. |
| PublicAPIResourceLevelPermissionsSupport | String | Indicates whether resource-level scope mapping support is enabled for public APIs. |
| PrivateAPIResourceLevelPermissionsSupport | String | Indicates whether resource-level scope mapping support is enabled for private APIs. |
| ValidateUniqueContextPath | String | Determines whether the Community Manager developer portal validates that the context path is unique for each API. If disabled, the same context path is allowed for multiple APIs (for example, /acmepaymentscorp). |