Name | Description | Schema | Default | Example |
---|---|---|---|---|
id optional |
UUID of the api registry artifact |
string | null |
01234567-0123-0123-0123-012345678901 |
name required |
Name of the API |
string | null |
CalculatorAPI |
description optional |
A brief description about the API |
string | null |
A calculator API that supports basic operations |
context required |
A string that represents the context of the user's request |
string | null |
CalculatorAPI |
version required |
The version of the API |
string | null |
1.0.0 |
provider optional |
If the provider value is not given user invoking the api will be used as the provider. |
string | null |
admin |
apiDefinition optional |
Swagger definition of the API which contains details about URI templates and scopes |
string | null |
{"paths":{"/substract":{"get":{"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","parameters":[{"name":"x","required":true,"type":"string","in":"query"},{"name":"y","required":true,"type":"string","in":"query"}],"responses":{"200":{}}}},"/add":{"get":{"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","parameters":[{"name":"x","required":true,"type":"string","in":"query"},{"name":"y","required":true,"type":"string","in":"query"}],"responses":{"200":{}}}}},"swagger":"2.0","info":{"title":"CalculatorAPI","version":"1.0.0"}} |
wsdlUri optional |
WSDL URL if the API is based on a WSDL endpoint |
string | null |
http://www.webservicex.com/globalweather.asmx?wsdl |
status optional |
This describes in which status of the lifecycle the API is |
string | null |
CREATED |
responseCaching optional |
string | null |
Disabled |
|
cacheTimeout optional |
integer | null |
300 |
|
destinationStatsEnabled optional |
string | null |
Disabled |
|
isDefaultVersion required |
boolean | null |
false |
|
type required |
string | null |
HTTP |
|
transport required |
Supported transports for the API (http and/or https). |
array | null |
["http","https"] |
tags optional |
Search keywords related to the API |
array | null |
["substract","add"] |
tiers required |
The subscription tiers selected for the particular API |
array | null |
["Unlimited"] |
maxTps optional |
API_maxTps | null |
||
thumbnailUri optional |
string | null |
/apis/01234567-0123-0123-0123-012345678901/thumbnail |
|
visibility required |
string | null |
PUBLIC |
|
visibleRoles optional |
The user roles that are able to access the API |
array | null |
[] |
endpointConfig required |
string | null |
{"production_endpoints":{"url":"https://localhost:9443/am/sample/pizzashack/v1/api/","config":{"suspendErrorCode":"101000","suspendDuration":"2000","suspendMaxDuration":"3","factor":"2","retryErroCode":"101000","retryTimeOut":"4","retryDelay":"1000","actionSelect":"fault","actionDuration":"3000"}},"sandbox_endpoints":{"url":"https://localhost:9443/am/sample/pizzashack/v1/api/","config":null},"endpoint_type":"http"} |
|
endpointSecurity optional |
API_endpointSecurity | null |
||
gatewayEnvironments optional |
Comma separated list of gateway environments. |
string | null |
Production and Sandbox |
sequences optional |
array | null |
[] |
|
subscriptionAvailability optional |
string | null |
current_tenant |
|
subscriptionAvailableTenants optional |
array | null |
[] |
|
additionalProperties optional |
Map of custom properties of API |
object | null |
|
accessControl optional |
Is the API is restricted to certain set of publishers or creators or is it visible to all the publishers and creators. If the accessControl restriction is none, this API can be modified by all the publishers and creators, if not it can only be viewable/modifiable by certain set of publishers and creators, based on the restriction. enum: - NONE - RESTRICTED |
string | null |
|
accessControlRoles optional |
The user roles that are able to view/modify as API publisher or creator. |
array | null |
["admin"] |
businessInformation optional |
API_businessInformation | null |
||
corsConfiguration optional |
API_corsConfiguration | null |