API

Name Description Schema Default Example

id

optional

UUID of the api registry artifact

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.

string

null

admin

apiDefinition

required

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

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).

array

null

null

tags

optional

array

null

null

tiers

required

array

null

null

maxTps

optional

API_maxTps

null

null

thumbnailUri

optional

string

null

/apis/01234567-0123-0123-0123-012345678901/thumbnail

visibility

required

string

null

PUBLIC

visibleRoles

optional

array

null

null

visibleTenants

optional

array

null

null

endpointConfig

required

string

null

{"production_endpoints":{"url":"https://127.0.0.1:9443/am/sample/calculator/v1/api","config":null},"implementation_status":"managed","endpoint_type":"http"}

endpointSecurity

optional

API_endpointSecurity

null

null

gatewayEnvironments

optional

Comma separated list of gateway environments.

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