Thanks for your feedback!
EDIT
How do I know what the "manager" API returns from the parameter settings?
The API query parameterization of the api-manager (GET /api-manager/apis) defines the format of the payload as well as whether APIs that are new versions of others will be returned or not.
The following list contains the parameters for API query response objects:
availableForApiIdentity = true
Does not return a new version
[
{
"id": 78,
"name": "api test draft",
"description": "draft",
"version": "1.0",
"creationDate": 1654865524000,
"plans": [],
"basePath": "/api-test",
"privateAPI": false,
"environments": [],
"revisions": [],
"appsCount": 0,
"accessTokenExpiresIn": 300,
"lastVersion": false,
"apiType": "IDENTITY",
"visibility": {
"id": 190,
"visibilityType": "ORGANIZATION",
"users": []
},
"apiSwaggerConfiguration": {
"id": 80,
"showAppRegister": true,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"apiIdentityConfiguration": {
"id": 1,
"apiIds": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": true
}
]
showOnAPIBrowser = true
Does not return a new version
[
{
"name": "ApiName Test",
"description": "APITest Description",
"version": "v1",
"plans": [],
"privateAPI": false,
"environments": [
{
"id": 1,
"inboundUrl": "http://sensedia.com/path/",
"showTrace": false
}
],
"revisions": [
{
"id": 1,
"interceptors": [],
"apiBroken": false,
"revisionNumber": 1,
"deployments": [],
"resources": []
}
],
"lastRevision": {
"id": 1,
"interceptors": [],
"apiBroken": false,
"revisionNumber": 1,
"deployments": [],
"resources": []
},
"appsCount": 0,
"lastVersion": false,
"apiSwaggerConfiguration": {
"showAppRegister": true,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": false
}
]
privateAPI = true
Does not return a new version
[
{
"id": -2,
"name": "API Metrics",
"description": "API Metrics",
"version": "3.0.0",
"creationDate": 1514764800000,
"plans": [
{
"id": -3,
"name": "Metrics Plan",
"description": "Metrics Plan",
"defaultPlan": true
}
],
"basePath": "/api-metrics/api/v3",
"privateAPI": true,
"environments": [],
"revisions": [],
"appsCount": 0,
"lastVersion": false,
"apiType": "REST",
"visibility": {
"id": 611,
"visibilityType": "ORGANIZATION",
"users": []
},
"apiSwaggerConfiguration": {
"id": 989,
"showAppRegister": false,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": false
}
]
filter = BASIC_WITHOUT_INTERCEPTORS
Returns a new version
[
{
"id": -2,
"name": "API Metrics",
"description": "API Metrics",
"version": "3.0.0",
"creationDate": 1514764800000,
"plans": [
{
"id": -3,
"name": "Metrics Plan",
"description": "Metrics Plan",
"defaultPlan": true
}
],
"basePath": "/api-metrics/api/v3",
"privateAPI": true,
"environments": [],
"revisions": [
{
"id": -2,
"destination": "$destinationMetrics/api-metrics/api/v3",
"interceptors": [],
"apiBroken": false,
"revisionNumber": 1,
"lifeCycle": "AVAILABLE",
"creationDate": 1514764800000,
"deployments": [],
"resources": [
{
"id": 227,
"destination": null,
"interceptors": [],
"apiBroken": false,
"timeout": null,
"certificateId": null,
"name": "Trace",
"description": null,
"operations": [
{
"id": 230,
"destination": null,
"interceptors": [],
"apiBroken": false,
"timeout": null,
"certificateId": null,
"description": null,
"method": "PUT",
"path": "/trace/obfuscation",
"async": false,
"urls": [],
"instruction": null
}
],
"connector": null
}
]
}
],
"lastRevision": {
"id": -2,
"destination": "$destinationMetrics/api-metrics/api/v3",
"interceptors": [],
"apiBroken": false,
"revisionNumber": 1,
"lifeCycle": "AVAILABLE",
"creationDate": 1514764800000,
"deployments": [],
"resources": [
{
"id": 226,
"destination": null,
"interceptors": [],
"apiBroken": true,
"timeout": null,
"certificateId": null,
"name": "Swagger",
"description": null,
"operations": [
{
"id": 233,
"destination": "$destinationMetrics/swagger-ui.html",
"interceptors": [],
"apiBroken": false,
"timeout": null,
"certificateId": null,
"description": null,
"method": "GET",
"path": "/swagger-ui.html",
"async": false,
"urls": [],
"instruction": null
}
],
"connector": null
},
{
"id": 227,
"destination": null,
"interceptors": [],
"apiBroken": false,
"timeout": null,
"certificateId": null,
"name": "Trace",
"description": null,
"operations": [
{
"id": 230,
"destination": null,
"interceptors": [],
"apiBroken": false,
"timeout": null,
"certificateId": null,
"description": null,
"method": "PUT",
"path": "/trace/obfuscation",
"async": false,
"urls": [],
"instruction": null
}
],
"connector": null
}
]
},
"appsCount": 0,
"lastVersion": true,
"apiType": "REST",
"visibility": {
"id": 611,
"visibilityType": "ORGANIZATION",
"users": []
},
"apiSwaggerConfiguration": {
"id": 989,
"showAppRegister": false,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": false
}
]
filter = BASIC_TO_DASHBOARD
Does not return a new version
[
{
"id": 1,
"name": "ApiName Test",
"version": "v1",
"plans": [],
"privateAPI": false,
"environments": [
{
"id": 1,
"name": "dashboad test",
"showTrace": false
}
],
"revisions": [
{
"id": 1,
"interceptors": [],
"apiBroken": false,
"revisionNumber": 1,
"deployments": [],
"resources": [
{
"id": 2,
"destination": null,
"interceptors": [],
"apiBroken": false,
"timeout": null,
"certificateId": null,
"name": "TestFilter",
"description": null,
"operations": [
{
"id": 3,
"destination": null,
"interceptors": [],
"apiBroken": false,
"timeout": null,
"certificateId": null,
"description": null,
"method": "GET",
"path": "/teste",
"async": false,
"urls": [],
"instruction": null
}
],
"connector": null
}
]
}
],
"lastRevision": {
"id": 1,
"interceptors": [],
"apiBroken": false,
"revisionNumber": 1,
"deployments": [],
"resources": [
{
"id": 2,
"destination": null,
"interceptors": [],
"apiBroken": false,
"timeout": null,
"certificateId": null,
"name": "TestFilter",
"description": null,
"operations": [
{
"id": 3,
"destination": null,
"interceptors": [],
"apiBroken": false,
"timeout": null,
"certificateId": null,
"description": null,
"method": "GET",
"path": "/teste",
"async": false,
"urls": [],
"instruction": null
}
],
"connector": null
}
]
},
"appsCount": 0,
"lastVersion": false,
"apiSwaggerConfiguration": {
"showAppRegister": true,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": false
}
]
filter = BASIC_WITH_LAST_REVISION
Returns a new version
[
{
"id": -2,
"name": "API Metrics",
"description": "API Metrics",
"version": "3.0.0",
"creationDate": 1514764800000,
"plans": [
{
"id": -3,
"name": "Metrics Plan",
"description": "Metrics Plan",
"defaultPlan": true
}
],
"basePath": "/api-metrics/api/v3",
"privateAPI": true,
"environments": [],
"revisions": [],
"lastRevision": {
"id": -2,
"destination": "$destinationMetrics/api-metrics/api/v3",
"interceptors": [],
"apiBroken": false,
"revisionNumber": 1,
"deployments": [],
"resources": []
},
"appsCount": 0,
"lastVersion": true,
"apiType": "REST",
"visibility": {
"id": 611,
"visibilityType": "ORGANIZATION",
"users": []
},
"apiSwaggerConfiguration": {
"id": 989,
"showAppRegister": false,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": false
}
]
filter = BASIC_TO_SEARCH
Returns a new version
[
{
"id": -2,
"name": "API Metrics",
"version": "3.0.0",
"hasNewVersion": false
}
]
filter = BASIC_WITH_PLANS
Returns a new version
[
{
"id": -2,
"name": "API Metrics",
"version": "3.0.0",
"creationDate": 1514764800000,
"description": "API Metrics",
"apiType": "REST",
"plans": [
{
"id": -3,
"name": "Metrics Plan",
"description": "Metrics Plan",
"defaultPlan": true
}
],
"hasNewVersion": false
}
]
filter = DEV_PORTAL
Returns a new version (starting with Manager version 4.11.0.0)
[
{
"id": 15,
"checked": null,
"name": "teste",
"version": "1.0.0",
"description": "",
"apiFormatted": "teste-1-0-0",
"plans": []
}
]
filter = CUSTOM and searchLevel = API
Returns a new version
[
{
"id": 2,
"name": "Child Api",
"description": "APITest Description",
"version": "v2",
"creationDate": 1663694671425,
"plans": [],
"parentId": 1,
"basePath": "/v2",
"privateAPI": false,
"environments": [],
"revisions": [],
"appsCount": 0,
"lastVersion": true,
"apiType": "REST",
"visibility": {
"id": 52,
"visibilityType": "ORGANIZATION",
"owner": {
"id": 1,
"name": "Teste junit-user-default",
"email": "default-user@mail.com",
"login": "defaultUser",
"roles": [
{
"id": 1,
"name": "RoleJunitUpdate",
"description": "Role for Junit test",
"permissions": [
{
"id": 4,
"permission": "TEAMS",
"type": "EDIT"
}
]
}
],
"teams": [],
"hasAllPermissions": false,
"userType": "DATABASE",
"traceEnvironments": [],
"mfaSecret": false,
"loginAttempts": 0,
"status": "ACTIVE"
},
"users": []
},
"apiSwaggerConfiguration": {
"id": 2,
"showAppRegister": true,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": false
}
]
filter = CUSTOM and searchLevel = RESOURCE
Does not return a new version
[
{
"id": 1,
"name": "Api 1",
"description": "Api 1 Description",
"version": "Api 1 Description",
"creationDate": 1663694989041,
"plans": [],
"basePath": "/test",
"privateAPI": false,
"environments": [],
"revisions": [],
"appsCount": 0,
"lastVersion": false,
"apiType": "REST",
"visibility": {
"id": 51,
"visibilityType": "ORGANIZATION",
"owner": {
"id": 1,
"name": "Teste junit-user-default",
"email": "default-user@mail.com",
"login": "defaultUser",
"roles": [
{
"id": 1,
"name": "RoleJunitUpdate",
"description": "Role for Junit test",
"permissions": [
{
"id": 8,
"permission": "INBOUND_ADDRESS",
"type": "EDIT"
}
]
}
],
"teams": [],
"hasAllPermissions": false,
"userType": "DATABASE",
"traceEnvironments": [],
"mfaSecret": false,
"loginAttempts": 0,
"status": "ACTIVE"
},
"users": []
},
"apiSwaggerConfiguration": {
"id": 1,
"showAppRegister": true,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": false
}
]
filter = CUSTOM and searchLevel = OPERATION
Does not return a new version
[
{
"id": 1,
"name": "Api 1",
"description": "Api 1 Description",
"version": "Api 1 Description",
"creationDate": 1663695307508,
"plans": [],
"basePath": "/test",
"privateAPI": false,
"environments": [],
"revisions": [],
"appsCount": 0,
"lastVersion": false,
"apiType": "REST",
"visibility": {
"id": 51,
"visibilityType": "ORGANIZATION",
"owner": {
"id": 1,
"name": "Teste junit-user-default",
"email": "default-user@mail.com",
"login": "defaultUser",
"roles": [
{
"id": 1,
"name": "RoleJunitUpdate",
"description": "Role for Junit test",
"permissions": [
{
"id": 3,
"permission": "ROLES",
"type": "EDIT"
}
]
}
],
"teams": [],
"hasAllPermissions": false,
"userType": "DATABASE",
"traceEnvironments": [],
"mfaSecret": false,
"loginAttempts": 0,
"status": "ACTIVE"
},
"users": []
},
"apiSwaggerConfiguration": {
"id": 1,
"showAppRegister": true,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": false
}
]
DEFAULT
Does not return a new version
[
{
"id": -1,
"name": "API Manager",
"description": "Manager API",
"version": "3.0.0",
"creationDate": 1354320000000,
"plans": [
{
"id": -5,
"name": "MFA Plan",
"description": "MFA Plan",
"defaultPlan": false
}
],
"basePath": "/api-manager/api/v3",
"privateAPI": true,
"environments": [],
"revisions": [],
"appsCount": 0,
"lastVersion": false,
"apiType": "REST",
"visibility": {
"id": 685,
"visibilityType": "ORGANIZATION",
"users": []
},
"apiSwaggerConfiguration": {
"id": 1110,
"showAppRegister": false,
"showApiBrowser": false,
"apiSwaggerConfigurationEnvironments": []
},
"internalAPI": false,
"tags": [],
"apiTags": [],
"identityApi": false
}
]
Share your suggestions with us!
Click here and then [+ Submit idea]