Name | Description | Schema | Default | Example |
---|---|---|---|---|
id optional |
UUID of the api registry artifact\n |
string | null |
01234567-0123-0123-0123-012345678901 |
name required |
string | null |
CalculatorAPI |
|
description optional |
string | null |
A calculator API that supports basic operations |
|
context required |
string | null |
CalculatorAPI |
|
version required |
string | null |
1.0.0 |
|
provider optional |
If the provider value is not given user invoking the api will be used as the provider.\n |
string | null |
admin |
apiDefinition required |
Swagger definition of the API which contains details about URI templates and scopes\n |
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"}} |
status optional |
string | null |
CREATED |
|
responseCaching optional |
string | null |
Disabled |
|
cacheTimeout optional |
integer | null |
300 |
|
destinationStatsEnabled optional |
string | null |
Disabled |
|
isDefaultVersion required |
boolean | null |
false |
|
transport required |
Supported transports for the API (http and/or https).\n |
array | null |
null |
tags optional |
array | null |
null |
|
tiers required |
array | null |
null |
|
thumbnailUrl optional |
string | null |
||
visibility required |
string | null |
PUBLIC |
|
visibleRoles optional |
array | null |
null |
|
visibleTenants optional |
array | null |
null |
|
endpointConfig required |
string | null |
{"production_endpoints":{"url":"http://localhost:9763/am/sample/calculator/v1/api","config":null},"implementation_status":"managed","endpoint_type":"http"} |
|
gatewayEnvironments optional |
Comma separated list of gateway environments.\n |
string | null |
Production and Sandbox |
sequences optional |
array | null |
null |
|
subscriptionAvailability optional |
string | null |
current_tenant |
|
subscriptionAvailableTenants optional |
array | null |
null |
|
businessInformation optional |
API_businessInformation | null |
null |
|
corsConfiguration optional |
API_corsConfiguration | null |
null |