API Platform API

2.0.0

Overview

Statistics
170 Operations
0 Skills
API Management Category
Manage APIs, applications, alerts, and classifications in the Anypoint API Platform repository.

Servers

  • US https://anypoint.mulesoft.com/apiplatform/repository/{version}
  • EU https://eu1.anypoint.mulesoft.com/apiplatform/repository/{version}
  • CA https://ca1.platform.mulesoft.com/apiplatform/repository/{version}
  • JP https://jp1.platform.mulesoft.com/apiplatform/repository/{version}
  • IN https://in1.platform.mulesoft.com/apiplatform/repository/{version}
  • AU https://au1.platform.mulesoft.com/apiplatform/repository/{version}

Authentication & Security

  • bearerAuth http

    Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login

  • clientAuth oauth2

    OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

List public APIs listPublicApisRoot

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of APIs.

Query Parameters

requireRaml *: boolean
Search only those APIs which have a publicly accesible RAML specification.
offset *: integer
limit *: integer
sort *: string
Property to sort by.
ascending *: boolean
Order for sorting.
query *: string
Search criteria.

Response

Successful operation.

Get the active organization getActiveOrganization

GET

Try it out

Custom Query Parameters
Custom Headers
Get the active organization.

Response

Successful operation.

Get an organization getOrganization

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get the organization.

Path Parameters

organizationId *: string

Query Parameters

extended *: boolean
Obtain extended information from the organization.
resolveTheme *: boolean
Resolves the theme inheritance.

Response

Successful.

Update an organization updateOrganization

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update the organization.

Path Parameters

organizationId *: string

Request Body

json

Response

Successful.

Delete an organization deleteOrganization

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete the organization.

Path Parameters

organizationId *: string

Response

Organization deleted.

Export migration mappings as CSV exportMigrationMappings

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get all api version migration mappings in CSV format. This is for setting up the Crowd upgrade.

Path Parameters

organizationId *: string

Response

Successful operation.

List organization permissions listOrgPermissions

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.

Path Parameters

organizationId *: string

Response

Successful operation.

List organization alerts listOrgAlerts

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets a collection of alerts.

Path Parameters

organizationId *: string

Query Parameters

apiVersionId *: string
The apiVersion ID query parameter.
tierId *: string
The tier ID query parameter.
lastModifiedSince *: integer
alertId *: string
The alert ID query parameter.
query *: string
Search criteria.
policyId *: string
The policy ID query parameter.
offset *: integer
apiId *: string
The api ID query parameter.
ascending *: boolean
Order for sorting.
severity *: string
The severity query parameter.
sort *: string
Property to sort by.
type *: string
The type query parameter.
limit *: integer
active *: boolean
The active query parameter.
environmentId *: string

Response

Successfully retrieved alert definitions.
Examples
application/json
{ "total": 1234, "data": [ { "apiVersion": { "name": "My First API", "id": 12345, "apiId": 67890 }, "name": "My First API's Request Count Alert", "severity": "warning", "recipients": [ { "role": "Api Version Owner" }, { "userId": "abcde-fghij-klmno", "name": "Jane Doe", "email": "jane.doe@example.com" } ], "period": { "duration": { "count": 1, "weight": "HOURS" }, "repeat": 4 }, "type": "requestCount", "condition": { "aggregate": "count", "operator": "GREATER_THAN", "value": 1000 } }, { "apiVersion": { "name": "My First API", "id": 12345, "apiId": 67890 }, "name": "My First API's Request Count Alert", "severity": "warning", "recipients": [ { "role": "Api Version Owner" }, { "userId": "abcde-fghij-klmno", "name": "Jane Doe", "email": "jane.doe@example.com" } ], "period": { "duration": { "count": 1, "weight": "HOURS" }, "repeat": 4 }, "type": "requestCount", "condition": { "aggregate": "count", "operator": "GREATER_THAN", "value": 1000 } } ] }

Create an organization alert createOrgAlert

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.

Path Parameters

organizationId *: string

Request Body

json

Response

The new element has been successfully created.

List environments listEnvironments

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.

Path Parameters

organizationId *: string

Query Parameters

withCloudhubPermissions *: boolean
all *: boolean

Response

Successful operation.

Get the default environment getDefaultEnvironment

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a default.

Path Parameters

organizationId *: string

Response

Successful operation.
Examples
application/json
{ "id": "80139f69-2845-46fa-9217-d9fe0171030f", "name": "QA", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "isProduction": false }

List API version alerts listApiVersionAlerts

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.

Path Parameters

organizationId *: string
environmentId *: string
apiId *: string
The api ID to identify the target resource.
apiVersionId *: string
The apiVersion ID to identify the target resource.

Response

Successfully retrieved an API Version's alert definitions.

Create an API version alert createApiVersionAlert

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.

Path Parameters

organizationId *: string
environmentId *: string
apiId *: string
The api ID to identify the target resource.
apiVersionId *: string
The apiVersion ID to identify the target resource.

Request Body

json
apiAlertsVersion *: any
name *: string
api *: object
apiVersion *: object
enabled *: boolean
severity *: any
recipients *: array
period *: object
condition *: object

Response

Successfully created alert definition.

Get an API version alert getApiVersionAlert

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets an alert.

Path Parameters

apiVersionId *: string
The apiVersion ID to identify the target resource.
alertId *: string
The alert ID to identify the target resource.
apiId *: string
The api ID to identify the target resource.
organizationId *: string
environmentId *: string

Response

json
Successfully retrieved alert definition.
apiAlertsVersion *: any
name *: string
api *: object
apiVersion *: object
enabled *: boolean
severity *: any
recipients *: array
period *: object
condition *: object
Examples
application/json
{}

Patch an API version alert patchApiVersionAlert

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a alert.

Path Parameters

apiVersionId *: string
The apiVersion ID to identify the target resource.
alertId *: string
The alert ID to identify the target resource.
apiId *: string
The api ID to identify the target resource.
organizationId *: string
environmentId *: string

Request Body

json
apiAlertsVersion: any
name: string
enabled: boolean
severity: any
recipients: array
period: object
condition: object

Response

Successfully updated alert definition.
Examples
application/json
{ "type": "api-request-count", "apiAlertsVersion": "1.0.0", "api": { "name": "My First API", "id": 22 }, "apiVersion": { "name": "First version", "id": 77 }, "enabled": true, "resources": [ "foo-api-version-id" ], "name": "My First API's Request Count Alert", "severity": "WARNING", "recipients": [ { "type": "role", "value": "API_VERSION_OWNER" }, { "type": "user", "value": "foo-user-id" }, { "type": "email", "value": "foo_email@example.com" } ], "period": { "duration": { "count": 1, "weight": "HOURS" }, "repeat": 4 }, "condition": { "resourceType": "api-version", "aggregate": "COUNT", "operator": "GREATER_THAN", "value": 1000, "filter": [ { "property": "apiVersionId", "operator": "EQUAL", "values": [ "foo-api-version-id" ] } ] } }

Delete an API version alert deleteApiVersionAlert

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the specified alert definition.

Path Parameters

apiVersionId *: string
The apiVersion ID to identify the target resource.
alertId *: string
The alert ID to identify the target resource.
apiId *: string
The api ID to identify the target resource.
organizationId *: string
environmentId *: string

Response

Successfully deleted alert definition.

Update organization theme updateOrgTheme

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Update the organization theme.

Path Parameters

organizationId *: string

Request Body

multipart/form-data

Response

Successful operation.

Get default organization theme getDefaultOrgTheme

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get the default theme for an organization.

Path Parameters

organizationId *: string

Response

Successful operation.

Get organization portal terms getPortalTerms

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets portal terms set for the organization.

Path Parameters

organizationId *: string

Response

Successful operation.

Create organization portal terms createPortalTerms

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create portal terms for the organization.

Path Parameters

organizationId *: string

Request Body

json

Response

Successful operation.

Delete organization portal terms deletePortalTerms

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes portal terms for the organization.

Path Parameters

organizationId *: string

Response

Operation completed successfully with no content returned.

Update portals redirect URI updatePortalsRedirectUri

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update redirect uri of the list of portals for the organization

Path Parameters

organizationId *: string

Request Body

json

Response

Successful operation.

List APIs listApis

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of APIs.

Path Parameters

organizationId *: string

Query Parameters

query *: string
Search criteria.
offset *: integer
filters *: string
The filters query parameter.
ascending *: boolean
Order for sorting.
requirePortal *: boolean
The requirePortal query parameter.
sort *: string
Property to sort by.
limit *: integer

Response

Successful operation.

Create an API createApi

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an API.

Path Parameters

organizationId *: string

Request Body

json

Response

The new element has been successfully created.

Get an API by name getApiByName

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a single API that matches the passed-in API name.
Returns null if no match is found.

Path Parameters

organizationId *: string

Query Parameters

apiName *: string
The apiName query parameter.

Response

Successful operation.

Create API version from Exchange spec createApiVersionFromExchange

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create an API Version from an Exchange Spec. Only available after the Crowd upgrade.

Path Parameters

organizationId *: string

Request Body

json
spec *: object
name *: string

Response

Resource created successfully.
Examples
application/json
{ "apiId": 26, "assetVersion": "1.0.0", "productVersion": "v1", "environmentId": null, "name": "unclassified api version from GAV", "order": 1, "audit": { "created": { "date": "2017-09-19T21:27:47.177000+00:00" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 97, "groupId": "f0c9b011-980e-4928-9430-e60e3a97c043", "assetId": "api-test", "tags": [], "terms": null }

List API versions by endpoint listApiVersionsByEndpoint

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of API versions for a given list of endpoints.

Path Parameters

organizationId *: string

Query Parameters

uris *: array
The uris query parameter.

Response

Successful operation.

Get an API version by name getApiVersionByName

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a single API that matches the passed-in API name
and API version name. Returns null if no match is found.

Path Parameters

organizationId *: string

Query Parameters

apiName *: string
The apiName query parameter.
versionName *: string
The versionName query parameter.

Response

Successful operation.

List permitted SLA tiers listPermittedTiers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns permitted SLA tiers within an organization.
It means every SLA tier that belongs to API version requesting user has access to.

Path Parameters

organizationId *: string

Response

Successful operation.

List applications with API contracts listContractedApplications

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns permitted applications within an organization.
It means every applications that has a contract with an API version requesting user has access to.

Path Parameters

organizationId *: string

Response

Successful operation.

Get an API and its versions getApi

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns an API and all its versions.

Path Parameters

organizationId *: string
apiId *: integer

Response

Successful operation.

Patch an API patchApi

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a apis.

Path Parameters

organizationId *: string
apiId *: integer

Request Body

json

Response

Successful operation.

Delete an API deleteApi

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a apis.

Path Parameters

organizationId *: string
apiId *: integer

Response

Operation completed successfully with no content returned.

List API portals listApiPortals

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a collection of API portals.

Path Parameters

organizationId *: string
apiId *: integer

Response

Successful operation.

Grant view access to an API grantApiPermission

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Grant a user view access to this API.

Path Parameters

organizationId *: string
apiId *: integer

Request Body

json

Response

The new element has been successfully created.

Create an API version createApiVersion

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an API version.

Path Parameters

organizationId *: string
apiId *: integer

Request Body

json

Response

The new element has been successfully created.

Get an API version getApiVersion

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

Update an API version updateApiVersion

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Patch an API version patchApiVersion

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Delete an API version deleteApiVersion

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

The element has been deleted successfully.

Classify an API version classifyApiVersion

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
(Only avaliable after the Crowd upgrade) Moves an API Version from the unclassified environment into a specified environment.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json
instanceLabel: any
environmentId *: string

Response

Resource created successfully.
Examples
application/json
{ "audit": { "created": { "date": "2017-09-01T18:34:50.783000+00:00" }, "updated": { "date": "2017-09-11T14:49:53.257000+00:00" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 25, "apiId": 5, "portalId": 11, "name": "dolorem 25", "instanceLabel": "my-instance-label", "groupId": "f0c9b011-980e-4928-9430-e60e3a97c043", "assetId": "api-test", "assetVersion": "1.0.0", "productVersion": "v1", "description": "accusamus dolorem et rerum placeat libero doloremque id quia vitae illo et suscipit sed nam ipsa qui in eum reiciendis incidunt corporis est iusto voluptas magnam pariatur adipisci fugiat voluptatibus odio aut sed culpa dignissimos sit quis quo est corrupti omnis quaerat voluptatum enim asperiores voluptatem exercitationem et accusantium illum", "tags": [ "accusantium", "voluptatem", "dolores", "hic", "nostrum", "quia", "aut", "alias", "in", "qui" ], "order": 5, "rootFileId": 23, "deprecated": false, "lastActiveDate": null, "endpointUri": null, "environmentId": "2ba4f3f8-0d26-49f6-8fd5-ea508abbb7ea", "isPublic": false, "terms": null, "termsDate": "2017-09-08T19:41:01.096000+00:00" }

Export an API version exportApiVersion

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Exports an API Version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

portal *: boolean
Include portal.
files *: boolean
Include definition files.
slaTiers *: boolean
Include SLA tiers.
portalAttachments *: boolean
Include portal attachments.
endpoint *: boolean
Include endpoint definition.
portalFiles *: boolean
Include portal images.

Response

Successful operation.
Examples
application/zip
{ "message": "Operation completed successfully." }

Search API version users listApiVersionUsers

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Search for users.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

search *: string
Search or filter expression to narrow results.
includeCurrent *: boolean
Whether to include the currently logged-in user in the search results or not.
offset *: integer
limit *: integer

Response

Successful operation.

List API version users by role listApiVersionUsersByRole

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Search for users who match a specific set of roles.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

API_VERSION_OWNER *: string
Context params for the API VERSION OWNER role.
PORTAL_ACCESS *: string
Context params for the PORTAL ACCESS role.

Response

Successful operation.

List API version owners listApiVersionOwners

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Return all owners of an API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

Grant admin access to API version grantApiVersionAccess

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Grant a user admin access to this API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Resource created successfully.

Revoke admin access to API version revokeApiVersionAccess

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Revoke a user's admin access to this API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

userId *: string
The user ID query parameter.

Response

Operation completed successfully with no content returned.

Get API version migration mapping getApiVersionMigration

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get the api version migration mapping of an API version

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

apiVersionId *: string
The apiVersion ID query parameter.

Response

Successful operation.
Examples
application/json
{ "masterOrganizationId": "9881ab9d-e73a-47cd-8105-d0b5f1a27fa1", "organizationId": "9881ab9d-e73a-47cd-8105-d0b5f1a27fa1", "id": 4399, "apiVersionId": 116409, "apiName": "newName", "apiVersionName": "newVersion", "migratePortal": true, "crowdOneAccount": false }

Create API version migration mapping createApiVersionMigration

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a migration mapping for an API version

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Resource created successfully.

Update API version migration mapping updateApiVersionMigration

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update a migration mapping of an API version

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Get API version portal getApiVersionPortal

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Obtain the portal associated with the API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

resolveTheme *: boolean
Resolves theme inheritance.

Response

Successful operation.

Create API version portal createApiVersionPortal

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a portal and associates it with an API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Resource created successfully.

Patch API version portal patchApiVersionPortal

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a portal and associates it with an API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Grant view access to API portal grantApiPortalAccess

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Grant a user view access to this portal.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Resource created successfully.

Revoke view access to API portal revokeApiPortalAccess

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Revoke a user's view access to portal.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

userId *: string
The user ID query parameter.

Response

Operation completed successfully with no content returned.

Update API portal redirect URI updateApiPortalRedirectUri

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update redirec uri for a portal

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Create an API portal page createApiPortalPage

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

The new element has been successfully created.

Update an API portal page updateApiPortalPage

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update an existing page.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
pageId *: integer

Request Body

json

Response

Successful operation.

Delete an API portal page deleteApiPortalPage

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a pages.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
pageId *: integer

Response

Operation completed successfully with no content returned.

List API portal page widgets listApiPortalPageWidgets

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns all content widgets of a page.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
pageId *: integer

Response

Successful operation.

Patch API portal page widgets patchApiPortalPageWidgets

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the collection of widgets.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
pageId *: integer

Request Body

json

Response

Successful operation.

Update API portal theme updateApiPortalTheme

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Update the portal theme.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

multipart/form-data

Response

Successful operation.

Upload an API portal file uploadApiPortalFile

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Upload an api portal file.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

multipart/form-data

Response

The new element has been successfully created.

Get an API portal file getApiPortalFile

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets the portal file.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
fileId *: string
The file ID to identify the target resource.

Response

Successful operation.

Delete an API portal file deleteApiPortalFile

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Removes the Portal file.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
fileId *: string
The file ID to identify the target resource.

Response

Operation completed successfully with no content returned.

Download an API portal file downloadApiPortalFile

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Same as parent get but allows to set a file name in the content-disposition header for downloading in a browser environment.

Path Parameters

fileId *: string
The file ID to identify the target resource.
apiVersionId *: integer
fileName *: string
The fileName to identify the target resource.
organizationId *: string
apiId *: integer

Response

Successful operation.

Add root RAML for API version addApiVersionRootRaml

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Adds the root RAML for this API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Resource created successfully.

Get API version RAML spec getApiVersionSpec

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets the RAML SPEC.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

Get API version endpoint getApiVersionEndpoint

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns the endpoint associated with the API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful.

Create API version endpoint createApiVersionEndpoint

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an endpoint for the API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

The endpoint has been created.

Update API version endpoint updateApiVersionEndpoint

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the endpoint associated with the API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

The endpoint has been updated.

Patch API version endpoint patchApiVersionEndpoint

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the endpoint associated with the API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Delete API version endpoint deleteApiVersionEndpoint

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the endpoint associated with the API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

The endpoint has been succesfully deleted.

Record API version endpoint activity recordEndpointActivity

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Records activity for an API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

The API version activity has been recorded.

List API version files listApiVersionFiles

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

Create an API version file createApiVersionFile

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

The new element has been successfully created.

Export API version files as ZIP exportApiVersionFiles

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Exports all files in the filesystem as a ZIP file.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.
Examples
application/zip
{ "message": "Operation completed successfully." }

Get an API version file getApiVersionFile

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Obtain a RAML file (or directory).

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
apiVersionFileId *: integer

Response

Successful operation.

Replace an API version file updateApiVersionFile

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces a files.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
apiVersionFileId *: integer

Request Body

json

Response

Successful operation.

Delete an API version file deleteApiVersionFile

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a files.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
apiVersionFileId *: integer

Response

Operation completed successfully with no content returned.

List API version policies listApiVersionPolicies

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

standalone *: boolean
The standalone query parameter.
version *: string
fullInfo *: boolean

Header Parameters

if-modified-since: number
Last modification date (EPOC)

Response

Successful operation.

Apply a policy to API version applyApiVersionPolicy

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

The new element has been successfully created.

Reorder API version policies reorderApiVersionPolicies

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates multiple policies. Currently, only updates in order field are supported.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Patch an API version policy patchApiVersionPolicy

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a policies.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
policyId *: integer

Request Body

json

Response

Successful operation.

Unapply an API version policy unapplyApiVersionPolicy

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Unapplies a policy.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
policyId *: integer

Response

Operation completed successfully with no content returned.

Disable an API version policy disableApiVersionPolicy

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a disable.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
policyId *: integer

Response

Resource created successfully.

Enable an API version policy enableApiVersionPolicy

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a enable.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
policyId *: integer

Response

Resource created successfully.

Add a tag to an API version addApiVersionTag

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Adds a tag to an API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
tag *: string

Response

Resource created successfully.

Remove a tag from an API version removeApiVersionTag

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Removes a tag from an API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
tag *: string

Response

Operation completed successfully with no content returned.

List API version SLA tiers listApiVersionTiers

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of tiers for the supplied api version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

query *: string
Search criteria.
offset *: integer
ascending *: boolean
Order for sorting.
sort *: string
Property to sort by.
limit *: integer
active *: boolean
Retrieve only active tiers if set to true.

Response

Successful operation.

Create an API version SLA tier createApiVersionTier

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a sla tier for the API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

The new element has been successfully created.

Update an API version SLA tier updateApiVersionTier

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update a tier associated with an API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
tierId *: integer

Request Body

json

Response

Successful operation.

Delete an API version SLA tier deleteApiVersionTier

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete a tier that has no active applications.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
tierId *: integer

Response

Operation completed successfully with no content returned.

List API version contracts listApiVersionContracts

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of applications with contracts with the API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

includeExtraRedirections *: boolean
The includeExtraRedirections query parameter.
query *: string
Search criteria.
offset *: integer
coreServicesId *: string
The coreServices ID query parameter.
status *: string
The status query parameter.
ascending *: boolean
Order for sorting.
sort *: string
Property to sort by.
limit *: integer
includeExtraApplicationData *: boolean
The includeExtraApplicationData query parameter.

Response

Successful operation.

Get an API version contract getApiVersionContract

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a specific contract for the API version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
contractId *: string

Response

Successful operation.

Patch an API version contract patchApiVersionContract

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches contract conditions.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
contractId *: string

Request Body

json

Response

Successful operation.

Delete an API version contract deleteApiVersionContract

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the contract.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
contractId *: string

Response

Operation completed successfully with no content returned.

Approve contract tier change approveContractTierChange

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a approveTierChange.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
contractId *: string

Response

Resource created successfully.

Approve a contract approveContract

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a approve.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
contractId *: string

Response

Resource created successfully.

Reject a contract rejectContract

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a reject.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
contractId *: string

Response

Resource created successfully.

Reject contract tier change rejectContractTierChange

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a rejectTierChange.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
contractId *: string

Response

Resource created successfully.

Restore a contract restoreContract

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a restore.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
contractId *: string

Response

Resource created successfully.

Revoke a contract revokeContract

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a revoke.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
contractId *: string

Response

Resource created successfully.

Get API version proxy getApiVersionProxy

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets a proxy.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Query Parameters

gatewayVersion *: string

Response

Successful operation.
Examples
application/zip
{ "message": "Operation completed successfully." }

Create proxy deployment createProxyDeployment

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a deployment.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Resource created successfully.

Patch proxy deployment patchProxyDeployment

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a deployment.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Get proxy deployment status getProxyDeploymentStatus

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the deployment details of a version.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

List compatible gateway versions listCompatibleGateways

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the gateway versions compatible

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

List policy templates listPolicyTemplates

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieve a list of policy templates.

Path Parameters

organizationId *: string

Query Parameters

version *: string

Response

Successful.

Get a policy template getPolicyTemplate

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieve specific details from the policy template, including the full
XML that is being injected as well as all of its configuration parameters.

Path Parameters

organizationId *: string
policyTemplateId *: string

Query Parameters

version *: string

Response

Successful.

List custom policy templates listCustomPolicyTemplates

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of custom policy templates.

Path Parameters

organizationId *: string

Query Parameters

query *: string
Search criteria.
offset *: integer
ascending *: boolean
Order for sorting.
sort *: string
Property to sort by.
limit *: integer

Response

Successful operation.

Create a custom policy template createCustomPolicyTemplate

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Creates a new custom policy.

Path Parameters

organizationId *: string

Request Body

multipart/form-data

Response

The new element has been successfully created.

Get a custom policy template getCustomPolicyTemplate

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.

Path Parameters

organizationId *: string
customPolicyTemplateId *: integer

Response

Successful operation.

Update a custom policy template updateCustomPolicyTemplate

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.

Path Parameters

organizationId *: string
customPolicyTemplateId *: integer

Request Body

json

Response

Successful operation.

Patch a custom policy template patchCustomPolicyTemplate

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.

Path Parameters

organizationId *: string
customPolicyTemplateId *: integer

Request Body

json

Response

Successful operation.

Delete a custom policy template deleteCustomPolicyTemplate

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.

Path Parameters

organizationId *: string
customPolicyTemplateId *: integer

Response

The element has been deleted successfully.

Get custom policy XML configuration getCustomPolicyConfig

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
The XML configuration for the custom policy template.

Path Parameters

organizationId *: string
customPolicyTemplateId *: integer

Response

Successful operation.
Examples
application/xml
{ "message": "Operation completed successfully." }

Get custom policy YAML definition getCustomPolicyDefinition

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
The YAML definition for the custom policy template.

Path Parameters

organizationId *: string
customPolicyTemplateId *: integer

Response

Successful operation.
Examples
application/yaml
{ "message": "Operation completed successfully." }

List portals listPortals

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.

Path Parameters

organizationId *: string

Response

Successful operation.

Create a portal createPortal

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.

Path Parameters

organizationId *: string

Request Body

json

Response

The new element has been successfully created.

Search organization users listOrgUsers

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Search for users

Path Parameters

organizationId *: string

Query Parameters

search *: string
The search string to query users for.
includeCurrent *: boolean
Whether to include the currently logged-in user in the search results or not.
offset *: integer
limit *: integer

Response

Successful operation.
Examples
application/json
{ "message": "Operation completed successfully." }

List applications listApplications

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of applications.

Path Parameters

organizationId *: string

Query Parameters

targetAdminSite *: boolean
Retrieve applications with all the information needed for the admin site.
query *: string
Search criteria.
includeContractsForApiVersion *: integer
This field is used to filter by API version.
offset *: integer
ascending *: boolean
Order for sorting.
sort: string
Property to sort by. Possible values 'id', 'name', 'status', 'createdDate' or 'updatedDate'.
limit *: integer

Response

Successful operation.

Create an application createApplication

POST

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new application.

Path Parameters

organizationId *: string

Query Parameters

apiVersionId: integer
groupInstanceId: integer

Request Body

json

Response

The new application has been successfully created.
Examples
application/json
{ "redirectUri": [ "http://123.123.123.123:8080/api/v1" ], "name": "App name", "description": "App Description", "url": "http://123.123.123.123:8080/api/v2", "coreServicesId": "d7eed6c45caa453ca763ba96b22e1bea", "clientId": "d7eed6c45caa453ca763ba96b22e1bea", "clientSecret": "53899407a628417d83ee480A099Bfc06", "audit": { "created": { "date": "2017-08-23T14:18:25.504000+00:00" }, "updated": {} }, "masterOrganizationId": "40fbc081-bb0d-4aff-9fb7-f3a48fdeb958", "grantTypes": [ "password", "implicit", "client_credentials", "authorization_code", "refresh_token" ], "id": 9 }

Get an application getApplication

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.

Path Parameters

organizationId *: string
applicationId *: string

Query Parameters

ignoreOwners *: boolean
Retrieve application with or without owners information.

Response

Successful operation.

Update an application updateApplication

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.

Path Parameters

organizationId *: string
applicationId *: string

Request Body

json

Response

Successful operation.

Patch an application patchApplication

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.

Path Parameters

organizationId *: string
applicationId *: string

Request Body

json

Response

Successful operation.

Delete an application deleteApplication

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.

Path Parameters

organizationId *: string
applicationId *: string

Response

The element has been deleted successfully.

Reset application client secret resetApplicationSecret

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a reset.

Path Parameters

organizationId *: string
applicationId *: string

Response

Resource created successfully.

List application party IDs listApplicationPartyIds

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of Party Ids for a specific api version.

Path Parameters

organizationId *: string
applicationId *: string

Query Parameters

apiVersionId *: integer
The apiVersion ID query parameter.

Response

Successful operation.

Add an application owner addApplicationOwner

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Adds an owner to an existing application.

Path Parameters

organizationId *: string
applicationId *: string

Request Body

json

Response

Resource created successfully.

Remove an application owner removeApplicationOwner

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Removes an owner from an existing application.

Path Parameters

organizationId *: string
applicationId *: string
userId *: string
The user ID to identify the target resource.

Response

Operation completed successfully with no content returned.

List application contracts listApplicationContracts

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of applications with contracts with the application.

Path Parameters

organizationId *: string
applicationId *: string

Query Parameters

query *: string
Search criteria.
offset *: integer
ascending *: boolean
Order for sorting.
sort *: string
Property to sort by.
limit *: integer

Response

Successful operation.

Create an application contract createApplicationContract

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates new contract between an API version and the application.

Path Parameters

organizationId *: string
applicationId *: string

Request Body

json

Response

The new element has been successfully created.

Patch an application contract patchApplicationContract

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches contract conditions.

Path Parameters

organizationId *: string
applicationId *: string
contractId *: string

Request Body

json

Response

Successful operation.

List organization contracts listOrgContracts

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a contracts.

Path Parameters

organizationId *: string

Query Parameters

apiVersionId *: integer
The apiVersion ID query parameter.
coreServicesId *: string
The coreServices ID query parameter.

Response

Successful operation.

List deployment targets listDeploymentTargets

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a deployment targets.

Path Parameters

organizationId *: string

Query Parameters

environmentId *: string

Response

Successful operation.

Create a bundle createBundle

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/zip
Creates a bundles.

Path Parameters

organizationId *: string

Request Body

zip

Response

Resource created successfully.

Get public organization favicon getPublicOrgFavicon

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a favicon.

Path Parameters

organizationId *: string

Response

Successful operation.

List public permissions listPublicPermissions

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a permissions.

Path Parameters

organizationId *: string

Response

Successful operation.

List public portals listPublicPortals

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.

Path Parameters

organizationId *: string

Query Parameters

query[tags] *: string
requireRaml *: boolean
The requireRaml query parameter.
query *: string
Search criteria.
query[name] *: string
query[version] *: string
offset *: integer
deep *: boolean
ascending *: boolean
Order for sorting.
query[description] *: string
organizationId *: string
sort *: string
Property to sort by.
query[matchAll] *: boolean
limit *: integer

Response

Successful operation.

Create a public portal createPublicPortal

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.

Path Parameters

organizationId *: string

Request Body

json

Response

The new element has been successfully created.

Get public portal favicon getPublicPortalFavicon

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a favicon.

Path Parameters

organizationId *: string
portalId *: integer

Response

Successful operation.

Get public portal terms getPublicPortalTerms

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a terms.

Path Parameters

organizationId *: string

Response

Successful operation.

Get portal terms acceptance getPortalTermsAcceptance

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a acceptance.

Path Parameters

organizationId *: string

Response

Successful operation.

Accept portal terms acceptPortalTerms

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a acceptance.

Path Parameters

organizationId *: string
portalTermsId *: integer

Response

Resource created successfully.

Get a public API getPublicApi

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.

Path Parameters

organizationId *: string
apiId *: integer

Response

Successful operation.

Update a public API updatePublicApi

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.

Path Parameters

organizationId *: string
apiId *: integer

Request Body

json

Response

Successful operation.

Patch a public API patchPublicApi

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.

Path Parameters

organizationId *: string
apiId *: integer

Request Body

json

Response

Successful operation.

Delete a public API deletePublicApi

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.

Path Parameters

organizationId *: string
apiId *: integer

Response

The element has been deleted successfully.

Get a public API version getPublicApiVersion

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

Update a public API version updatePublicApiVersion

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Patch a public API version patchPublicApiVersion

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Delete a public API version deletePublicApiVersion

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

The element has been deleted successfully.

Get public API portal getPublicApiPortal

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a portal.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

List public portal page widgets listPublicPortalWidgets

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a widgets.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
pageId *: string
The page ID to identify the target resource.

Response

Successful operation.

Get a public portal file getPublicPortalFile

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve the file by file id. Content-type will be set based on the content-type originally received.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
fileId *: string
The file ID to identify the target resource.

Response

Successful.

Download a public portal file downloadPublicPortalFile

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Same as parent get but allows to set a file name in the content-disposition header for downloading in a browser environment.

Path Parameters

fileId *: string
The file ID to identify the target resource.
apiVersionId *: integer
fileName *: string
The fileName to identify the target resource.
apiId *: integer
organizationId *: string

Response

Successful operation.

List public API SLA tiers listPublicApiTiers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a tiers.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

Get public API version spec getPublicApiSpec

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets the RAML SPEC.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Successful operation.

Update public API version spec updatePublicApiSpec

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Patch public API version spec patchPublicApiSpec

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Request Body

json

Response

Successful operation.

Delete public API version spec deletePublicApiSpec

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

The element has been deleted successfully.

Redirect to public API root RAML redirectPublicApiRoot

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Redirect to the root RAML file.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Temporary redirect to the root RAML file.

Get public API root RAML file getPublicApiRootFile

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve the root RAML file contents.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer

Response

Temporary redirect to the root RAML file.

Get public API file by name getPublicApiFile

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve the RAML contents by file name.

Path Parameters

organizationId *: string
apiId *: integer
apiVersionId *: integer
+fileName *: string
The +fileName to identify the target resource.

Response

Successful.

Get a policy getPolicy

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a policies.

Path Parameters

policyId *: integer

Response

Successful operation.

Get a CloudHub domain getCloudhubDomain

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a ch domains.

Path Parameters

domainName *: string
The domainName to identify the target resource.

Response

Successful operation.

List gateway versions listGatewayVersions

GET

Try it out

Custom Query Parameters
Custom Headers
Retrieves a list of gateway versions.

Response

Successful operation.