API Manager Services

Summary

The API Manager Services REST API provides access to some control API Manager's service

Description

With the API Manager Services API, it is possible to query and update API Manager configuration

Resources

Resource	Since Version	Description
GET /api/portal/v1.3/alerts	1.1	Gets the alerts configured for the API Manager
POST /api/portal/v1.3/alerts	1.1	Updates the API Manager alerts configuration
GET /api/portal/v1.3/appinfo	1.2	Gets API Manager feature information.
POST /api/portal/v1.3/certinfo	1.1	Extracts certificate information from the supplied data
POST /api/portal/v1.3/certinfo	1.1	Extracts certificate information from the supplied data
GET /api/portal/v1.3/config		Gets API Manager configuration
PUT /api/portal/v1.3/config		Updates the API Manager configuration
GET /api/portal/v1.3/connectors	1.3	Return a list of API connectors
GET /api/portal/v1.3/connectors/{connectorId}	1.3	Return a list of APIs for the specified connector
POST /api/portal/v1.3/connectors/{connectorId}/login	1.3	Login to an external service from which APIs will be imported
POST /api/portal/v1.3/filedata	1.1	Returns the DataURI representation of the uploaded file
GET /api/portal/v1.3/license		Checks that the API Manager has a valid license
GET /api/portal/v1.3/listeners	1.1	Gets the API Manager listeners
GET /api/portal/v1.3/oauthclientprofiles	1.2	Get a list of OAuth profiles for use in backend API authorisation
GET /api/portal/v1.3/policies	1.1	Gets a list of the specified policies
GET /api/portal/v1.3/remotehosts	1.1	Returns a list of remote hosts
POST /api/portal/v1.3/remotehosts	1.1	Creates a new remote host
PUT /api/portal/v1.3/remotehosts/{id}	1.1	Updates a remote host
DELETE /api/portal/v1.3/remotehosts/{id}	1.1	Deletes a remote host.
POST /api/portal/v1.3/service-discovery/{instance}/{type}	1.2	Returns a list of services hosted on the specified Gateway instance
GET /api/portal/v1.3/sysconfig		Gets API Manager system configuration
PUT /api/portal/v1.3/sysconfig		Update API Manager system configuration
GET /api/portal/v1.3/title		Gets the API Manager's title
GET /api/portal/v1.3/tokenstores	1.1	Gets a list of Token Stores
POST /api/portal/v1.3/topology	1.2	Retrieves the Topology from the specified Admin Node Manager

GET /api/portal/v1.3/alerts

Summary

Gets the alerts configured for the API Manager

Description

Gets the alerts configured for the API Manager that shows which alerts are enabled/disabled for the application. Only the API Administrator may call this method.

Since

1.1

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK
403	Forbidden

Returns Class

AlertConfig

POST /api/portal/v1.3/alerts

Summary

Updates the API Manager alerts configuration

Description

Updates the API Manager alerts configuration. Only the API Administrator may call this method.

Since

1.1

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`-`	API alert system configuration	AlertConfig	body	Required

Status Codes

HTTP Status Code	Reason
201	Created
403	Forbidden

Returns Class

AlertConfig

Example

POST https://localhost:8075/api/portal/v1.3/alerts

Request

{
  "runSysquotaExceeded" : false,
  "runSysquotaWarning" : false,
  "runAppquotaExceeded" : false,
  "runAppquotaWarning" : false,
  "quotaOverrideChanged" : false,
  "quotaOverrideDeleted" : false,
  "quotaDefaultChanged" : false,
  "quotaSystemChanged" : false,
  "organizationCreate" : false,
  "organizationDelete" : false,
  "organizationEnable" : false,
  "organizationDisable" : false,
  "organizationAddapi" : false,
  "organizationRemoveapi" : false,
  "organizationEnableapi" : false,
  "organizationDisableapi" : false,
  "appdevRegister" : false,
  "appdevApprove" : false,
  "appdevDelete" : false,
  "appdevEnable" : false,
  "appdevDisable" : false,
  "appdevResetpwd" : false,
  "applicationRegister" : false,
  "applicationApprove" : false,
  "applicationDelete" : false,
  "applicationEnable" : false,
  "applicationDisable" : false,
  "applicationRequestapi" : false,
  "applicationApproveapi" : false,
  "applicationRemoveapi" : false,
  "applicationEnableapi" : false,
  "applicationDisableapi" : false,
  "apicatalogEnable" : false,
  "apicatalogDisable" : false,
  "apiproxyPublish" : false,
  "apiproxyDeprecate" : false,
  "apiproxyUndeprecate" : false,
  "apiproxyRetire" : false,
  "apiproxyUnpublish" : false
}

Response
HTTP 1.1 200 OK

{
  "runSysquotaExceeded" : false,
  "runSysquotaWarning" : false,
  "runAppquotaExceeded" : false,
  "runAppquotaWarning" : false,
  "quotaOverrideChanged" : false,
  "quotaOverrideDeleted" : false,
  "quotaDefaultChanged" : false,
  "quotaSystemChanged" : false,
  "organizationCreate" : false,
  "organizationDelete" : false,
  "organizationEnable" : false,
  "organizationDisable" : false,
  "organizationAddapi" : false,
  "organizationRemoveapi" : false,
  "organizationEnableapi" : false,
  "organizationDisableapi" : false,
  "appdevRegister" : false,
  "appdevApprove" : false,
  "appdevDelete" : false,
  "appdevEnable" : false,
  "appdevDisable" : false,
  "appdevResetpwd" : false,
  "applicationRegister" : false,
  "applicationApprove" : false,
  "applicationDelete" : false,
  "applicationEnable" : false,
  "applicationDisable" : false,
  "applicationRequestapi" : false,
  "applicationApproveapi" : false,
  "applicationRemoveapi" : false,
  "applicationEnableapi" : false,
  "applicationDisableapi" : false,
  "apicatalogEnable" : false,
  "apicatalogDisable" : false,
  "apiproxyPublish" : false,
  "apiproxyDeprecate" : false,
  "apiproxyUndeprecate" : false,
  "apiproxyRetire" : false,
  "apiproxyUnpublish" : false
}

GET /api/portal/v1.3/appinfo

Summary

Gets API Manager feature information.

Description

Returns an API Manager configuration object describing the application.

Since

1.2

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK

Returns Class

Config

POST /api/portal/v1.3/certinfo

Summary

Extracts certificate information from the supplied data

Description

Extracts certificate information from the supplied data.

Since

1.1

Parameters

Parameter	Data Type	Location
`url`	String	form
`username`	String	form
`password`	String	form
`inbound`	boolean	form
`outbound`	boolean	form

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request

POST /api/portal/v1.3/certinfo

Summary

Extracts certificate information from the supplied data

Description

Extracts certificate information from the supplied data.

Since

1.1

Parameters

Parameter	Data Type	Location
`username`	String	form
`file`	File	form
`passphrase`	String	form
`inbound`	boolean	form
`outbound`	boolean	form

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request

GET /api/portal/v1.3/config

Summary

Gets API Manager configuration

Description

Returns an API Manager configuration object.

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK
403	Forbidden

Returns Class

Config

PUT /api/portal/v1.3/config

Summary

Updates the API Manager configuration

Description

Updates the API Manager configuration. Only the API Administrator may call this method.

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`-`	API Manager configuration	Config	body	Required

Status Codes

HTTP Status Code	Reason
200	OK
403	Forbidden

Returns Class

Config

Example

PUT https://localhost:8075/api/portal/v1.3/config

Request

{
  "portalName" : "Axway API Manager",
  "portalHostname" : "apimanager.axway.com",
  "apiPortalName" : "Axway API Portal",
  "apiPortalHostname" : "apiportal.axway.com",
  "isApiPortalConfigured" : true,
  "registrationEnabled" : true,
  "resetPasswordEnabled" : true,
  "minimumPasswordLength" : 6,
  "autoApproveUserRegistration" : true,
  "systemOAuthScopesEnabled" : false,
  "autoApproveApplications" : true,
  "delegateUserAdministration" : true,
  "delegateApplicationAdministration" : true,
  "apiDefaultVirtualHost" : "apimanager.axway.com:443",
  "emailFrom" : "no-reply@axway.com",
  "emailBounceAddress" : "apiadmin@axway.com",
  "promoteApiViaPolicy" : true,
  "baseOAuth" : false,
  "externalUserName" : "${userinfo.name}",
  "externalUserDescription" : "${userinfo.description}",
  "externalUserPhone" : "${userinfo.phone}",
  "externalUserEmail" : "${userinfo.email}",
  "externalUserOrganization" : "${userinfo.organization}",
  "externalUserRole" : "${userinfo.role}",
  "externalUserEnabled" : "${userinfo.enabled}",
  "sessionIdleTimeout" : 360000,
  "isTrial" : false,
  "defaultTrialDuration" : 30,
  "loginNameRegex" : "[^;,\\/?#<>&!]{1,}"
}

Response
HTTP 1.1 200 OK

{
  "portalName" : "Axway API Manager",
  "portalHostname" : "apimanager.axway.com",
  "apiPortalName" : "Axway API Portal",
  "apiPortalHostname" : "apiportal.axway.com",
  "isApiPortalConfigured" : true,
  "registrationEnabled" : true,
  "resetPasswordEnabled" : true,
  "minimumPasswordLength" : 6,
  "autoApproveUserRegistration" : true,
  "systemOAuthScopesEnabled" : false,
  "autoApproveApplications" : true,
  "delegateUserAdministration" : true,
  "delegateApplicationAdministration" : true,
  "apiDefaultVirtualHost" : "apimanager.axway.com:443",
  "emailFrom" : "no-reply@axway.com",
  "emailBounceAddress" : "apiadmin@axway.com",
  "promoteApiViaPolicy" : true,
  "baseOAuth" : false,
  "externalUserName" : "${userinfo.name}",
  "externalUserDescription" : "${userinfo.description}",
  "externalUserPhone" : "${userinfo.phone}",
  "externalUserEmail" : "${userinfo.email}",
  "externalUserOrganization" : "${userinfo.organization}",
  "externalUserRole" : "${userinfo.role}",
  "externalUserEnabled" : "${userinfo.enabled}",
  "sessionIdleTimeout" : 360000,
  "isTrial" : false,
  "defaultTrialDuration" : 30,
  "loginNameRegex" : "[^;,\\/?#<>&!]{1,}"
}

GET /api/portal/v1.3/connectors

Summary

Return a list of API connectors

Description

Return a list of API connectors.

Since

1.3

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request
403	Forbidden
500	Internal Server Error

Returns Array

[ Map ]

Example

GET https://localhost:8075/api/portal/v1.3/connectors

Response
HTTP 1.1 200 OK

{
  "id" : "sf123",
  "name" : "Salesforce",
  "version" : "v1",
  "maxApisPerImport" : 100
}

GET /api/portal/v1.3/connectors/{connectorId}

Summary

Return a list of APIs for the specified connector

Description

Return a list of APIs for the specified connector.

Since

1.3

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`connectorId`	ID of the connector for which APIs should be returned. Connector IDs can be retrieved by calling /connectors.	String	path	Required

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request
403	Forbidden
500	Internal Server Error

Returns Array

[ Map ]

Example

GET https://localhost:8075/api/portal/v1.3/connectors/{connectorId}

Response
HTTP 1.1 200 OK

[ {
  "name" : "Folder 1",
  "children" : [ {
    "id" : "api1",
    "name" : "Api 1"
  } ]
} ]

POST /api/portal/v1.3/connectors/{connectorId}/login

Summary

Description

Since

1.3

Parameters

Parameter	Description	Data Type	Location	Required
`connectorId`	ID of the API connector. Connector IDs can be retrieved by calling /connectors.	String	path	Required
`username`	External service username	String	form	Required
`password`	External service password	String	form	Required

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request
403	Forbidden
500	Internal Server Error

Returns Class

String

POST /api/portal/v1.3/filedata

Summary

Returns the DataURI representation of the uploaded file

Description

Returns the DataURI representation of the uploaded file.

Since

1.1

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`file`		File	form

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request

GET /api/portal/v1.3/license

Summary

Checks that the API Manager has a valid license

Description

Returns an API Manager license configuration object. Does not require authentication.

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK

Returns Class

String

GET /api/portal/v1.3/listeners

Summary

Gets the API Manager listeners

Description

Returns a list of API Manager listeners.

Since

1.1

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK
403	Forbidden

Returns Array

[ PortalTrafficListener ]

GET /api/portal/v1.3/oauthclientprofiles

Summary

Get a list of OAuth profiles for use in backend API authorisation

Description

Return a list of OAuth Client Profiles for use in authorising API access to backend APIs.

Since

1.2

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request

Returns Array

[ ReferencedEntity ]

GET /api/portal/v1.3/policies

Summary

Gets a list of the specified policies

Description

Returns the list of policies (of the specified type) that are available to Portal-registered APIs. type is one of: request, routing, response, promotion, authentication or token-info.

Since

1.1

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`type`	The type of policy to return. Possible values are: 'request', 'routing', 'response', 'authentication', 'oauthtokeninfo', 'promotion'	String	query	Required

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request

Returns Array

[ ReferencedEntity ]

GET /api/portal/v1.3/remotehosts

Summary

Returns a list of remote hosts

Description

Returns a list of API Manager-registered remote hosts.

Since

1.1

Parameters

none

Status Codes

HTTP Status Code	Reason
200	OK
403	Forbidden

Returns Array

[ RemoteHost ]

POST /api/portal/v1.3/remotehosts

Summary

Creates a new remote host

Description

Creates a new API Manager-regsitered remote host. Dynamically updates the API Gateway runtime so that the remote host is available.

Since

1.1

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`-`	An API Manager-registered remote host.	RemoteHost	body	Required

Status Codes

HTTP Status Code	Reason
201	Created
400	Bad Request
403	Forbidden
500	Internal Server Error

Returns Class

RemoteHost

Example

POST https://localhost:8075/api/portal/v1.3/remotehosts

Request

{
	"name" : "www.google.com",
	"port" : 80,
	"organizationId" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
	"maxConnections" : 128,
	"allowHTTP11" : false,
	"includeContentLengthRequest" : false,
	"includeContentLengthResponse" : false,
	"offerTLSServerName" : false,
	"verifyServerHostname" : false,
	"connectionTimeout" : 30000,
	"activeTimeout" : 30000,
	"transactionTimeout" : 240000,
	"idleTimeout" : 15000,
	"maxReceiveBytes" : 10485760,
	"maxSendBytes" : 10485760,
	"inputBufferSize" : 8192,
	"outputBufferSize" : 8192,
	"addressCacheTimeout" : 300000,
	"sslSessionCacheSize" : 32,
	"exportCorrelationId" : true
}

Response
HTTP 1.1 201 Created

{
  "id" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "name" : "www.google.com",
  "port" : 80,
  "createdOn" : 1364287486876,
  "createdBy" : "de077cd8-83b7-46d1-b06f-2eaaf1548898",
  "organizationId" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "maxConnections" : 128,
  "allowHTTP11" : false,
  "includeContentLengthRequest" : false,
  "includeContentLengthResponse" : false,
  "offerTLSServerName" : false,
  "verifyServerHostname" : false,
  "connectionTimeout" : 30000,
  "activeTimeout" : 30000,
  "transactionTimeout" : 240000,
  "idleTimeout" : 15000,
  "maxReceiveBytes" : 10485760,
  "maxSendBytes" : 10485760,
  "inputBufferSize" : 8192,
  "outputBufferSize" : 8192,
  "addressCacheTimeout" : 300000,
  "sslSessionCacheSize" : 32,
  "inputEncodings" : [ "deflate", "gzip" ],
  "outputEncodings" : [ "deflate", "gzip" ],
  "exportCorrelationId" : true
}

PUT /api/portal/v1.3/remotehosts/{id}

Summary

Updates a remote host

Description

Updates an API Manager-registered remote host. Dynamically updates the API Gateway runtime so that the new remote host settings are available.

Since

1.1

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`id`	The remote host identifier.	String	path	Required
`-`	An API Manager-registered remote host.	RemoteHost	body	Required

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request
403	Forbidden
500	Internal Server Error

Returns Class

RemoteHost

Example

PUT https://localhost:8075/api/portal/v1.3/remotehosts/{id}

Request

{
  "id" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "name" : "www.google.com",
  "port" : 80,
  "createdOn" : 1364287486876,
  "createdBy" : "de077cd8-83b7-46d1-b06f-2eaaf1548898",
  "organizationId" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "maxConnections" : 128,
  "allowHTTP11" : false,
  "includeContentLengthRequest" : false,
  "includeContentLengthResponse" : false,
  "offerTLSServerName" : false,
  "verifyServerHostname" : false,
  "connectionTimeout" : 30000,
  "activeTimeout" : 30000,
  "transactionTimeout" : 240000,
  "idleTimeout" : 15000,
  "maxReceiveBytes" : 10485760,
  "maxSendBytes" : 10485760,
  "inputBufferSize" : 8192,
  "outputBufferSize" : 8192,
  "addressCacheTimeout" : 300000,
  "sslSessionCacheSize" : 32,
  "inputEncodings" : [ "deflate", "gzip" ],
  "outputEncodings" : [ "deflate", "gzip" ],
  "exportCorrelationId" : true
}

Response
HTTP 1.1 200 OK

{
  "id" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "name" : "www.google.com",
  "port" : 80,
  "createdOn" : 1364287486876,
  "createdBy" : "de077cd8-83b7-46d1-b06f-2eaaf1548898",
  "organizationId" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "maxConnections" : 128,
  "allowHTTP11" : false,
  "includeContentLengthRequest" : false,
  "includeContentLengthResponse" : false,
  "offerTLSServerName" : false,
  "verifyServerHostname" : false,
  "connectionTimeout" : 30000,
  "activeTimeout" : 30000,
  "transactionTimeout" : 240000,
  "idleTimeout" : 15000,
  "maxReceiveBytes" : 10485760,
  "maxSendBytes" : 10485760,
  "inputBufferSize" : 8192,
  "outputBufferSize" : 8192,
  "addressCacheTimeout" : 300000,
  "sslSessionCacheSize" : 32,
  "inputEncodings" : [ "deflate", "gzip" ],
  "outputEncodings" : [ "deflate", "gzip" ],
  "exportCorrelationId" : true
}

DELETE /api/portal/v1.3/remotehosts/{id}

Summary

Deletes a remote host.

Description

Deletes an API Manager-registered remote host. Dynamically removes the remote host from the API Gateway runtime.

Since

1.1

Parameters

Parameter	Description	Data Type	Location	Required	Multiple
`id`	The remote host identifier.	String	path	Required

Status Codes

HTTP Status Code	Reason
204	No Content
400	Bad Request
403	Forbidden

POST /api/portal/v1.3/service-discovery/{instance}/{type}

Parameter	Description	Data Type	Location	Required
`instance`		String	path	Required
`type`	The type of service to return. Possible values are: 'rest', 'wsdl'	String	path	Required
`host`		String	form
`port`		String	form
`username`		String	form
`password`		String	form

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request
403	Forbidden
500	Internal Server Error

Returns Array

[ Swagger ]

Example

POST https://localhost:8075/api/portal/v1.3/service-discovery/{instance}/{type}?type=rest

Response
HTTP 1.1 200 OK

[ {
  "id" : "",
  "format" : "",
  "apiVersion" : "1.0",
  "swaggerVersion" : "1.1",
  "basePath" : "http://basepath.org",
  "resourcePath" : "/api",
  "models" : {
    "User" : {
      "type" : "object",
      "required" : [ "id", "name", "email" ],
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "name" : {
          "type" : "string"
        },
        "email" : {
          "type" : "string"
        }
      }
    }
  },
  "consumes" : [ "\"application/json\"" ],
  "produces" : [ "\"application/json\"" ],
  "authorizations" : { },
  "name" : "Flickr",
  "summary" : "The Flickr photo-sharing API",
  "securityProfile" : {
    "devices" : [ {
      "type" : "APIKeyOnlySecurityDevice",
      "typeDisplayName" : "API Key only",
      "name" : "API Key Device",
      "order" : 1,
      "keyField" : "KeyId"
    }, {
      "type" : "HTTPBasicSecurityDevice",
      "typeDisplayName" : "HTTP Basic Authentication",
      "name" : "HTTP Basic Device",
      "order" : 0,
      "realm" : "axway"
    } ]
  },
  "basePaths" : [ "http://localhost:8080", "https://localhost:8081" ],
  "image" : "",
  "state" : "rest",
  "cors" : true,
  "expired" : false,
  "deprecated" : false,
  "retirementDate" : 1420070400000,
  "tags" : {
    "Category" : [ "Social Network", "Photos" ],
    "Type" : [ "REST" ],
    "Department" : [ "Development" ]
  },
  "documentationUrl" : "http://api.acme.com/docs#method",
  "availableApiDefinitions" : { },
  "availableSDK" : { },
  "apis" : [ {
    "id" : "",
    "format" : "",
    "path" : "/users",
    "name" : "",
    "operations" : [ {
      "id" : "",
      "format" : "",
      "httpMethod" : "GET",
      "nickname" : "getUserById",
      "summary" : "Gets a user by ID",
      "notes" : "If the user does not exist, then a *404 Not Found* error is returned",
      "responseClass" : "User",
      "errorResponses" : [ {
        "id" : "",
        "format" : "",
        "code" : 404,
        "reason" : "Not Found",
        "$ref" : "#/definitions/User",
        "type" : "string"
      } ],
      "consumes" : [ "\"application/json\"" ],
      "produces" : [ "\"application/json\"" ],
      "authorizations" : { },
      "tags" : {
        "Category" : [ "Social Network", "Photos" ],
        "Type" : [ "REST" ],
        "Department" : [ "Development" ]
      },
      "securityProfile" : {
        "devices" : [ {
          "type" : "APIKeyOnlySecurityDevice",
          "typeDisplayName" : "API Key only",
          "name" : "API Key Device",
          "order" : 1,
          "keyField" : "KeyId"
        }, {
          "type" : "HTTPBasicSecurityDevice",
          "typeDisplayName" : "HTTP Basic Authentication",
          "name" : "HTTP Basic Device",
          "order" : 0,
          "realm" : "axway"
        } ]
      },
      "documentationUrl" : "http://api.acme.com/docs#method",
      "cors" : true,
      "parameters" : [ {
        "id" : "",
        "format" : "",
        "required" : true,
        "name" : "userId",
        "dataType" : "string",
        "paramType" : "body",
        "allowMultiple" : false,
        "$ref" : "#/definitions/User",
        "defaultValue" : "Sample Value",
        "type" : "string"
      } ],
      "$ref" : "#/definitions/User",
      "type" : "User"
    } ],
    "$ref" : "#/definitions/User",
    "type" : "string"
  } ],
  "$ref" : "#/definitions/User",
  "type" : "rest"
} ]

HTTP Status Code	Reason
200	OK
403	Forbidden

Returns Class

SystemConfig

Parameter	Description	Data Type	Location	Required	Multiple
`-`	API Manager system configuration	SystemConfig	body	Required

Status Codes

HTTP Status Code	Reason
200	OK
403	Forbidden

Returns Class

SystemConfig

Example

PUT https://localhost:8075/api/portal/v1.3/sysconfig

Request

{
  "disabledApis" : [ "c1c63d3b-5283-4755-ade7-e2377bd35049" ]
}

Response
HTTP 1.1 200 OK

{
  "disabledApis" : [ "c1c63d3b-5283-4755-ade7-e2377bd35049" ]
}

HTTP Status Code	Reason
200	OK

Returns Class

String

HTTP Status Code	Reason
200	OK
400	Bad Request

Returns Array

[ ReferencedEntity ]

Parameter	Description	Data Type	Location	Required
`host`	The host on which the Admin Node Manager is running	String	form	Required
`port`	The Admin Node Manager management port.	String	form	Required
`username`	Username to use for Admin Node Manager authentication .	String	form	Required
`password`	Password to use for Admin Node Manager authentication.	String	form	Required

Status Codes

HTTP Status Code	Reason
200	OK
400	Bad Request
403	Forbidden
500	Internal Server Error

Returns Array

[ WebServiceInfo ]

Example

POST https://localhost:8075/api/portal/v1.3/topology?type=rest

Response
HTTP 1.1 200 OK

[ {
  "name" : "LinkedIn REST API",
  "type" : "rest",
  "version" : "1.0",
  "id" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "uri" : "http://footballpool.dataaccess.eu/data/info.wso?WSDL"
} ]

GET /api/portal/v1.3/alerts

POST /api/portal/v1.3/alerts

GET /api/portal/v1.3/appinfo

POST /api/portal/v1.3/certinfo

POST /api/portal/v1.3/certinfo

GET /api/portal/v1.3/config

PUT /api/portal/v1.3/config

GET /api/portal/v1.3/connectors

GET /api/portal/v1.3/connectors/{connectorId}

POST /api/portal/v1.3/connectors/{connectorId}/login

POST /api/portal/v1.3/filedata

GET /api/portal/v1.3/license

GET /api/portal/v1.3/listeners

GET /api/portal/v1.3/oauthclientprofiles

GET /api/portal/v1.3/policies

GET /api/portal/v1.3/remotehosts

POST /api/portal/v1.3/remotehosts

PUT /api/portal/v1.3/remotehosts/{id}

DELETE /api/portal/v1.3/remotehosts/{id}

POST /api/portal/v1.3/service-discovery/{instance}/{type}

GET /api/portal/v1.3/sysconfig