APIDetailed

Name Description Schema Default Example

id

optional

UUID of the api registry artifact

string

null

01234567-0123-0123-0123-012345678901

name

optional

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

optional

A string that represents the context of the user's request

string

null

CalculatorAPI

version

optional

The version of the API

string

null

1.0.0

provider

optional

If the provider value is not given, the user invoking the API will be used as the provider.

string

null

admin

status

optional

This describes in which status of the lifecycle the API is

string

null

CREATED

thumbnailUri

optional

string

null

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

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

responseCaching

optional

string

null

Disabled

cacheTimeout

optional

integer

null

300

destinationStatsEnabled

optional

string

null

Disabled

isDefaultVersion

optional

boolean

null

false

type

optional

The api creation type to be used. Accepted values are HTTP, WS, SOAPTOREST

string

null

HTTP

transport

optional

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

optional

The subscription tiers selected for the particular API

array

null

["Unlimited"]

apiLevelPolicy

optional

The policy selected for the particular API

string

null

Unlimited

authorizationHeader

optional

Name of the Authorization header used for invoking the API. If it is not set, Authorization header name specified in tenant or system level will be used.

string

null

apiSecurity

optional

Type of API security, the current API secured with. It can be either OAuth2 or mutual SSL or both. If it is not set OAuth2 will be set as the security for the current API.

string

null

maxTps

optional

APIMaxTps

null

visibility

optional

The visibility level of the API. Accepts one of the following. PUBLIC, PRIVATE, RESTRICTED OR CONTROLLED.

string

null

PUBLIC

visibleRoles

optional

The user roles that are able to access the API

array

null

[]

visibleTenants

optional

array

null

endpointConfig

optional

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

APIEndpointSecurity

null

gatewayEnvironments

optional

Comma separated list of gateway environments.

string

null

Default

labels

optional

Labels of micro-gateway environments attached to the API.

array

null

sequences

optional

array

null

"\"sequences\": [ {\"name\": \"json_to_xml_in_message\",\"config\": null,\"type\": \"in\"}, {\"name\": \"xml_to_json_out_message\",\"config\": null,\"type\": \"out\"}, {\"name\": \"json_fault\",\"config\": null,\"type\": \"fault\"} ],"

subscriptionAvailability

optional

The subscription availability. Accepts one of the following. current_tenant, all_tenants or specific_tenants.

string

null

current_tenant

subscriptionAvailableTenants

optional

array

null

["tenant1","tenant2"]

additionalProperties

optional

Map of custom properties of API

map

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.

string

null

accessControlRoles

optional

The user roles that are able to view/modify as API publisher or creator.

array

null

["admin"]

businessInformation

optional

APIBusinessInformation

null

corsConfiguration

optional

APICorsConfiguration

null