API Manager API

1.0.0

Overview

Statistics
118 Operations
4 Skills
API Management Category
Manage APIs, policies, contracts, and SLA tiers within Anypoint Platform. Create, configure, deploy, and monitor APIs across organizations and environments, including API policies, client application contracts, automated policies, API groups, upstream configurations, and TLS contexts.

Servers

  • US https://anypoint.mulesoft.com/apimanager/api/v1
  • EU https://eu1.anypoint.mulesoft.com/apimanager/api/v1
  • CA https://ca1.platform.mulesoft.com/apimanager/api/v1
  • JP https://jp1.platform.mulesoft.com/apimanager/api/v1
  • IN https://in1.platform.mulesoft.com/apimanager/api/v1
  • AU https://au1.platform.mulesoft.com/apimanager/api/v1

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

Import a client application importApplication

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Imports a Client Application from an external client provider
Connected Apps require Manage Client Applications scope

Path Parameters

organizationId *: string

Request Body *

json
clientId *: string
providerId *: string
description: string
url: string

Response

Application succesfully imported
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

List APIs listApiInstances

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a collection of APIs

Connected Apps require the following scopes:
- View APIs Configuration

Path Parameters

organizationId *: string
environmentId *: string

Query Parameters

query: string
A string that will be checked for a partial or similar matches of the name, description, label and tags
groupId: string
assetId: string
assetVersion: string
instanceLabel: string
A string that will be checked for an exact match of the instanceLabel
productVersion: string
A string that will be checked for an exact match of the productVersion
autodiscoveryInstanceName: string
A string that will be checked for an exact match of the autodiscoveryInstanceName
autodiscoveryApiName: string
A string that will be checked for an exact match of the autodiscoveryApiName
family: string
filters: string
Comma-separated list of filters, which can be "active" and/or "pinned"
offset: integer
limit: integer
sort: string
ascending: any

Response

json
Success. Returns the requested resource.
total: integer
assets: array
Examples
Apis
{ "value": { "total": 2, "assets": [ { "audit": { "created": { "date": "2017-08-03T22:37:53.989Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 16, "name": "Api", "groupId": null, "assetId": null, "apis": [ { "audit": { "created": { "date": "2017-08-06T20:21:50.666Z" }, "updated": { "date": "2017-08-06T20:28:35.662Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 95, "instanceLabel": null, "autodiscoveryInstanceName": "alerts", "assetVersion": null, "productVersion": null, "description": "", "tags": [], "order": 1, "deprecated": false, "lastActiveDate": "2017-08-02T18:50:10.842Z", "endpointUri": null, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "lastActiveDelta": 419033, "pinned": false, "activeContractsCount": 0 } ], "totalApis": 1 }, { "audit": { "created": { "date": "2017-07-19T20:46:19.420Z" }, "updated": { "date": "2017-08-03T15:07:26.338Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 5, "name": "apiName", "groupId": null, "assetId": null, "apis": [ { "audit": { "created": { "date": "2017-07-19T20:46:19.621Z" }, "updated": { "date": "2017-08-03T21:28:31.317Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 25, "instanceLabel": null, "autodiscoveryInstanceName": "some name!", "assetVersion": null, "productVersion": null, "description": "some description!", "tags": [ "quas", "consectetur", "quidem", "et", "veritatis", "itaque", "ipsum", "ut", "deleniti", "voluptatem" ], "order": 5, "deprecated": false, "lastActiveDate": "2017-08-02T18:50:10.842Z", "endpointUri": "/google.com", "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "lastActiveDelta": 419033, "pinned": false, "activeContractsCount": 1 }, { "audit": { "created": { "date": "2017-07-31T19:10:04.228Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 79, "instanceLabel": null, "autodiscoveryInstanceName": "promotedApiName4", "assetVersion": null, "productVersion": null, "description": "sint enim maiores officiis aliquam minima ipsam quas animi voluptatem aut necessitatibus quod deleniti voluptatem aut est aut adipisci mollitia aliquid rerum iure maxime provident libero non repellendus labore et ut facere quidem repudiandae quis nihil doloremque harum eum ipsum magnam velit aspernatur porro atque nulla qui temporibus dicta totam", "tags": [ "excepturi", "quia", "nisi", "molestias", "sint", "labore", "itaque", "non", "alias", "blanditiis" ], "order": 4, "deprecated": false, "lastActiveDate": null, "endpointUri": null, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "pinned": false, "activeContractsCount": 4 }, { "audit": { "created": { "date": "2017-07-19T20:46:19.621Z" }, "updated": { "date": "2017-07-31T18:39:56.291Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 24, "instanceLabel": null, "autodiscoveryInstanceName": "ad 24", "assetVersion": null, "productVersion": null, "description": "sint enim maiores officiis aliquam minima ipsam quas animi voluptatem aut necessitatibus quod deleniti voluptatem aut est aut adipisci mollitia aliquid rerum iure maxime provident libero non repellendus labore et ut facere quidem repudiandae quis nihil doloremque harum eum ipsum magnam velit aspernatur porro atque nulla qui temporibus dicta totam", "tags": [ "excepturi", "quia", "nisi", "molestias", "sint", "labore", "itaque", "non", "alias", "blanditiis" ], "order": 4, "deprecated": false, "lastActiveDate": "2017-07-31T18:25:34.766Z", "endpointUri": null, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "lastActiveDelta": 593309, "pinned": false, "activeContractsCount": 1 } ], "totalApis": 3 } ] } }

Create an API createApiInstance

POST

Try it out

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

Connected Apps require the following scopes:
- Manage APIs Configuration
- Exchange Viewer

Path Parameters

organizationId *: string
environmentId *: string

Request Body *

json
instanceLabel: string | null
endpoint: object
providerId: string | null
technology: string
file: string(binary)
Binary file with the API package in ZIP/Bundle archive. May include tiers, endpoint settings, and policies.
instanceLabel: string
endpoint: object
JSON of endpoint, which will override any enpoint passed in the file and the policies (if any)
providerId: string
Client identity system ID. When empty, defaults to CS.
Examples
Api
{ "value": { "instanceLabel": "My label", "spec": { "groupId": "com.mulesoft", "assetId": "ramlspec", "version": "1.0.0" }, "endpoint": { "uri": "https://some.implementation.com", "proxyUri": "http://0.0.0.0:8081/", "isCloudHub": false, "deploymentType": "RF", "tlsContexts": { "inbound": { "secretGroupId": "8f5c4947-feea-4683-aa38-42ad97584d51", "tlsContextId": "1d3b677a-7c9f-4c9b-b143-cf257835f9a8" }, "outbound": null } }, "technology": "mule3" } }

Response

json
Created. The resource was successfully created.
environmentId: string
autodiscoveryInstanceName: string
masterOrganizationId: string
organizationId: string
apiId: number
assetVersion:
productVersion:
providerId: string
instanceLabel: string
description: string
tags: array
order: number
endpointUri:
lastActiveDelta: number
audit: object
Examples
Promote
{ "value": { "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "autodiscoveryInstanceName": "promotedApiName", "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "apiId": 91, "assetVersion": null, "productVersion": null, "providerId": "2e71d283-6248-4c81-98eb-e254a89b7e0a", "instanceLabel": "some instance label", "description": "sint enim maiores officiis aliquam minima ipsam quas animi voluptatem aut necessitatibus quod deleniti voluptatem aut est aut adipisci mollitia aliquid rerum iure maxime provident libero non repellendus labore et ut facere quidem repudiandae quis nihil doloremque harum eum ipsum magnam velit aspernatur porro atque nulla qui temporibus dicta totam", "tags": [ "excepturi", "quia", "nisi", "molestias", "sint", "labore", "itaque", "non", "alias", "blanditiis" ], "order": 4, "endpointUri": null, "lastActiveDelta": 181073, "audit": { "created": { "date": "2017-08-02T20:43:27.864Z" }, "updated": {} } } }

Get an API getApiInstance

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns an API

Connected Apps require the following scopes:
- View APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Query Parameters

includeProxyTemplate: any
Include the configured proxyTemplate to its associated endpoint
includeValidation: any
Include the configured validation to its associated endpoint
includeTlsContexts: any
Include the configured TLS contexts

Response

json
Success. Returns the requested resource.
audit: object
masterOrganizationId: string
organizationId: string
apiId: number
instanceLabel:
autodiscoveryInstanceName: string
assetVersion:
productVersion:
description: string
tags: array
order: number
deprecated: boolean
lastActiveDate: string
endpointUri:
environmentId: string
endpoint: object
deployment: object
lastActiveDelta: number
Examples
Api
{ "value": { "audit": { "created": { "date": "2017-07-19T20:46:19.621Z" }, "updated": { "date": "2017-08-02T18:50:10.843Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "apiId": 25, "instanceLabel": null, "autodiscoveryInstanceName": "dignissimos 25", "assetVersion": null, "productVersion": null, "description": "eius esse sed voluptatem in est beatae dolorem et fugit sequi quia adipisci quam repudiandae in nemo provident eaque natus cum aut aut et sit aut rerum iusto et quia sunt voluptatem similique vero aut saepe nihil est quia molestiae nobis laudantium et commodi iure corrupti doloremque excepturi ab sed", "tags": [ "quas", "consectetur", "quidem", "et", "veritatis", "itaque", "ipsum", "ut", "deleniti", "voluptatem" ], "order": 5, "deprecated": false, "lastActiveDate": "2017-08-02T18:50:10.842Z", "endpointUri": null, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "endpoint": { "audit": { "created": {}, "updated": {} }, "id": 24, "type": "http", "uri": "http://example.com/24", "proxyUri": "http://0.0.0.0:8081/api", "proxyRegistrationUri": null, "lastActiveDate": null, "isCloudHub": null, "deploymentType": "HY", "policiesVersion": "", "referencesUserDomain": null, "responseTimeout": null, "validation": "NOT_APPLICABLE" }, "deployment": { "audit": { "created": {}, "updated": {} }, "id": 3, "applicationId": null, "applicationName": "test-depl2", "gatewayVersion": "3.8.0", "environmentName": "ApiManagerEnv", "environmentId": "1c9fec69-7f17-40c9-abcc-56a0bbed73d9", "targetId": null, "targetName": null, "deploymentId": null, "updatedDate": null, "type": "CH", "apiId": 77 }, "lastActiveDelta": 7462 } }

Update an API updateApiInstance

PUT

Try it out

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

Connected Apps require the following scopes:
- Manage APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

json
Created. The resource was successfully created.
autodiscoveryInstanceName: string
instanceLabel: string
pinned: boolean
order: number
description: string
endpoint: object
id: number
environmentId: string
audit: object
masterOrganizationId: string
organizationId: string
Examples
Api
{ "value": { "autodiscoveryInstanceName": "v2:test-api", "instanceLabel": "new-label", "pinned": false, "order": 3, "description": "changed description", "endpoint": { "audit": { "created": { "date": "2017-08-11T21:55:38.401Z" }, "updated": { "date": "2017-08-16T20:23:57.176Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 22, "type": "raml", "uri": "http://my-ep-uri.com.ar", "proxyUri": "http://0.0.0.0:8081/api", "proxyRegistrationUri": null, "lastActiveDate": null, "isCloudHub": null, "deploymentType": "RF", "policiesVersion": "", "referencesUserDomain": null, "responseTimeout": null, "apiId": 23 }, "id": 23, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "audit": { "created": {}, "updated": { "date": "2017-08-16T20:23:57.176Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043" } }

Update an API patchApiInstance

PATCH

Try it out

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

Connected Apps require the following scopes:
- Manage APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Query Parameters

force: any
updateApisInSamePort: any
For APIs deployed to Flex, if endpoint proxyUri or inbound TLS Contexts are being updated, apis in the same port are also updated

Request Body *

json
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

json
Success. Returns the requested resource.
autodiscoveryInstanceName: string
instanceLabel: string
pinned: boolean
order: number
description: string
endpoint: object
id: number
environmentId: string
audit: object
masterOrganizationId: string
organizationId: string
Examples
Api
{ "value": { "autodiscoveryInstanceName": "v2:test-api", "instanceLabel": "new-label", "pinned": false, "order": 3, "description": "changed description", "endpoint": { "audit": { "created": { "date": "2017-08-11T21:55:38.401Z" }, "updated": { "date": "2017-08-16T20:23:57.176Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 22, "type": "raml", "uri": "http://my-ep-uri.com.ar", "proxyUri": "http://0.0.0.0:8081/api", "proxyRegistrationUri": null, "lastActiveDate": null, "isCloudHub": null, "deploymentType": "RF", "policiesVersion": "", "referencesUserDomain": null, "responseTimeout": null, "apiId": 23 }, "id": 23, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "audit": { "created": {}, "updated": { "date": "2017-08-16T20:23:57.176Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043" } }

Delete an API deleteApiInstance

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes an API

Connected Apps require the following scopes:
- Manage APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

No Content. The operation completed successfully with no response body.

Pin an API version pinApiInstance

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Pins an environment API version

Connected Apps require the following scopes:
- View APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

Created. The resource was successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Unpin an API version unpinApiInstance

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Unpins an environment API version

Connected Apps require the following scopes:
- View APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

No Content. The operation completed successfully with no response body.

List API upstreams listApiInstanceUpstreams

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get API version upstreams

Connected Apps require the following scopes:
- View APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

json
Success. Returns the requested resource.
total: number
upstreams: array
Examples
Upstreams
{ "value": { "total": 1, "upstreams": [ { "id": "7d1715b4-88ed-4987-ac59-63d5b6766ba1", "label": null, "uri": "http://upstream-test.com" } ] } }

Create an API upstream createApiInstanceUpstream

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create an upstream for an API version

Connected Apps require the following scopes:
- Manage APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
uri: string | null
label: string
Examples
application/json
{ "uri": "https://example.com", "label": "my-upstream" }

Response

Created. The resource was successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Get an API upstream getApiInstanceUpstream

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get an upstream

Connected Apps require the following scopes:
- View APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string
upstreamId *: string

Response

json
Success. Returns the requested resource.
id: string
label:
uri: string
Examples
Upstream
{ "value": { "id": "7d1715b4-88ed-4987-ac59-63d5b6766ba1", "label": null, "uri": "http://upstream-test.com" } }

Update an API upstream updateApiInstanceUpstream

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patch an upstream

Connected Apps require the following scopes:
- Manage APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string
upstreamId *: string

Request Body *

json
uri: string | null
label: string
Examples
application/json
{ "uri": "https://example.com", "label": "my-upstream" }

Response

json
Success. Returns the requested resource.
id: string
label:
uri: string
Examples
Upstream
{ "value": { "id": "7d1715b4-88ed-4987-ac59-63d5b6766ba1", "label": null, "uri": "http://upstream-test.com" } }

Delete an API upstream deleteApiInstanceUpstream

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete an upstream

Connected Apps require the following scopes:
- Manage APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string
upstreamId *: string

Response

Response with status code default.
Examples
application/json
{ "message": "Success" }

List API policies listApiInstancePolicies

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets a collection of API Policies

Connected Apps require the following scopes:
- View Policies

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Query Parameters

standalone: any
When true, returns only standalone policies. When false (default), returns all policies regardless of deployment mode.
version: string
fullInfo: any

Header Parameters

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

Response

json
Success. Returns the requested resource.
items: array
Array items
Examples
Policies
{ "value": [ { "audit": { "created": { "date": "2017-03-17T12:00:00Z" }, "updated": {} }, "masterOrganizationId": "e9a32dc8-5568-4211-9760-fd96392e4025", "organizationId": "e9a32dc8-5568-4211-9760-fd96392e4025", "id": 2620780, "policyTemplateId": "1939", "configurationData": { "rateLimits": [ { "maximumRequests": 100, "timePeriodInMilliseconds": 60000 } ], "exposeHeaders": true, "clusterizable": true }, "order": 1, "disabled": false, "pointcutData": [ { "methodRegex": "GET", "uriTemplateRegex": "v1" } ], "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "assetId": "rate-limiting", "assetVersion": "1.4.0", "implementationAsset": { "assetId": "rate-limiting-mule", "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "version": "1.4.0", "technology": "mule4", "minRuntimeVersion": "4.1.0", "supportedJavaVersions": [ "8", "17", "11" ] }, "type": "system", "apiId": 4040871 } ] }

Apply a new API policy applyApiInstancePolicy

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Applies a new API Policy

Connected Apps require the following scopes:
- Manage Policies

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
configurationData: object
pointcutData: array | null
order:: integer
groupId: string
assetId: string
assetVersion: string
apiVersionId: integer
policyTemplateId: string
Examples
application/json
{ "name": "Example Resource", "description": "Example description" }

Response

The new element has been successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Reorder API policies reorderApiInstancePolicies

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.

Connected Apps require the following scopes:
- Manage Policies

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
items: array
Array items
Examples
application/json
[ { "id": 51, "order": 1 }, { "id": 63, "order": 2 } ]

Response

Success. Returns the requested resource.
Examples
application/json
{ "message": "Resource updated successfully" }

Get an API policy getApiInstancePolicy

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a specific policy for the API

Connected Apps require the following scopes:
- View Policies

Path Parameters

policyId *: integer
environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

json
Success. Returns the requested resource.
items: array
Array items
Examples
Policies
{ "value": [ { "audit": { "created": { "date": "2017-03-17T12:00:00Z" }, "updated": {} }, "masterOrganizationId": "e9a32dc8-5568-4211-9760-fd96392e4025", "organizationId": "e9a32dc8-5568-4211-9760-fd96392e4025", "id": 2620780, "policyTemplateId": "1939", "configurationData": { "rateLimits": [ { "maximumRequests": 100, "timePeriodInMilliseconds": 60000 } ], "exposeHeaders": true, "clusterizable": true }, "order": 1, "disabled": false, "pointcutData": [ { "methodRegex": "GET", "uriTemplateRegex": "v1" } ], "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "assetId": "rate-limiting", "assetVersion": "1.4.0", "implementationAsset": { "assetId": "rate-limiting-mule", "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "version": "1.4.0", "technology": "mule4", "minRuntimeVersion": "4.1.0", "supportedJavaVersions": [ "8", "17", "11" ] }, "type": "system", "apiId": 4040871 } ] }

Update an API policy updateApiInstancePolicy

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates an API policy

Connected Apps require the following scopes:
- Manage Policies

Path Parameters

policyId *: integer
environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

Success. Returns the requested resource.
Examples
application/json
{ "message": "Resource updated successfully" }

Unapply an API policy unapplyApiInstancePolicy

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Unapplies a policy

Connected Apps require the following scopes:
- Manage Policies

Path Parameters

policyId *: integer
environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

No Content. The operation completed successfully with no response body.

Update policy implementation asset updateApiInstancePolicyImplementationAsset

POST

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Updates the implementation asset

Connected Apps require the following scopes:
- Manage Policies

Path Parameters

policyId *: integer
environmentApiId *: integer
organizationId *: string
environmentId *: string

Query Parameters

dryRun: any
Perform a dry run of the implementation update

Response

Created. The resource was successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

List API tiers listApiInstanceTiers

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of tiers for the supplied API

Connected Apps require the following scopes:
- View Contracts

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Query Parameters

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

Response

json
Success. Returns the requested resource.
total: number
tiers: array
Examples
Tiers
{ "value": { "total": 2, "tiers": [ { "audit": { "created": { "date": "2017-07-19T20:46:22.196Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 47, "name": "consectetur 47", "description": "ea nisi est eius libero\nnon consequatur vel repudiandae ipsa rerum\ndolores vel eos tenetur animi", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": false } ], "status": "ACTIVE", "autoApprove": false, "applicationCount": 0, "apiId": 25 }, { "audit": { "created": { "date": "2017-07-19T20:46:22.197Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 48, "name": "magni 48", "description": "incidunt sit eius vel quo qui qui ex et\nrerum possimus laudantium fugit minima aut perferendis\nmaiores dolore tempore non", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": true } ], "status": "DEPRECATED", "autoApprove": true, "applicationCount": 1, "apiId": 25 } ] } }

Create an SLA tier for the API createApiInstanceTier

POST

Try it out

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

Connected Apps require the following scopes:
- Manage Contracts

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
name *: string
autoApprove: boolean
limits: array
status *: string
Examples
Tier
{ "value": { "status": "ACTIVE", "autoApprove": true, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "name": "tierName", "description": "tier description" } }

Response

json
The new element has been successfully created.
total: number
tiers: array
Examples
Tiers
{ "value": { "total": 2, "tiers": [ { "audit": { "created": { "date": "2017-07-19T20:46:22.196Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 47, "name": "consectetur 47", "description": "ea nisi est eius libero\nnon consequatur vel repudiandae ipsa rerum\ndolores vel eos tenetur animi", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": false } ], "status": "ACTIVE", "autoApprove": false, "applicationCount": 0, "apiId": 25 }, { "audit": { "created": { "date": "2017-07-19T20:46:22.197Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 48, "name": "magni 48", "description": "incidunt sit eius vel quo qui qui ex et\nrerum possimus laudantium fugit minima aut perferendis\nmaiores dolore tempore non", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": true } ], "status": "DEPRECATED", "autoApprove": true, "applicationCount": 1, "apiId": 25 } ] } }

Count API tiers checkApiInstanceTiers

HEAD

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a count tiers of the API version

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

Success. Returns the requested resource.

Update an API tier updateApiInstanceTier

PUT

Try it out

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

Connected Apps require the following scopes:
- Manage Contracts

Path Parameters

tierId *: integer
environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
name: string
limits: array
status: string
Examples
Tier
{ "value": { "status": "ACTIVE", "autoApprove": true, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "name": "tierName", "description": "tier description" } }

Response

json
Created. The resource was successfully created.
status: string
autoApprove: boolean
apiId: number
limits: array
name: string
description: string
audit: object
masterOrganizationId: string
organizationId: string
id: number
Examples
Tier
{ "value": { "status": "ACTIVE", "autoApprove": true, "apiId": 25, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "name": "tierName", "description": "tier description", "audit": { "created": { "date": "2017-08-03T21:33:57.041Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 190 } }

Delete an API tier deleteApiInstanceTier

DELETE

Try it out

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

Connected Apps require the following scopes:
- Manage Contracts

Path Parameters

tierId *: integer
environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

No Content. The operation completed successfully with no response body.

List API group tiers listApiInstanceGroupTiers

GET

Try it out

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

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

Success. Returns the requested resource.
Examples
application/json
{ "total": 0, "data": [] }

Create an API group tier createApiInstanceGroupTier

POST

Try it out

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

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
Examples
application/json
{ "name": "Example Resource", "description": "Example description" }

Response

The new element has been successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Count API group tiers checkApiInstanceGroupTiers

HEAD

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a count group tiers of the API version

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

Success. Returns the requested resource.

List API group contracts listApiInstanceGroupContracts

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of group contracts of the API version

Connected Apps require the following scopes:
- View Contracts

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

json
Success. Returns the requested resource.
total: number
contracts: array
Examples
Contracts
{ "value": { "total": 2, "contracts": [ { "audit": { "created": { "date": "2017-07-19T20:46:22.440Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 24, "status": "APPROVED", "approvedDate": "2017-07-19T20:46:22.520Z", "rejectedDate": null, "revokedDate": null, "applicationId": 1, "application": { "audit": { "created": { "date": "2017-07-19T20:46:19.307Z" }, "updated": {} }, "id": 1, "name": "dolor 1", "description": "repudiandae quo ab veritatis recusandae consequatur perferendis delectus corporis illo rerum officia quia quaerat ut dolorem eos illum optio odio alias amet nihil consequatur et et reprehenderit voluptate vel ipsa corrupti et dicta sint minus rerum culpa rerum labore temporibus qui dolores porro dolor quam molestias ea est aliquid nam", "coreServicesId": "98ecdda9dc524b37b141e2cc3ee19747", "url": "http://sample-app.com/1" }, "tierId": 48, "tier": { "audit": { "created": { "date": "2017-07-19T20:46:22.197Z" }, "updated": {} }, "id": 48, "name": "magni 48", "description": "incidunt sit eius vel quo qui qui ex et\nrerum possimus laudantium fugit minima aut perferendis\nmaiores dolore tempore non", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": true } ], "status": "DEPRECATED", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "partyId": null, "partyName": null, "apiId": 25, "api": { "audit": { "created": {}, "updated": {} }, "id": 25 } }, { "audit": { "created": { "date": "2017-08-03T22:13:14.533Z" }, "updated": { "date": "2017-08-03T22:16:36.673Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 77, "status": "APPROVED", "approvedDate": "2017-08-03T22:16:36.673Z", "rejectedDate": null, "revokedDate": null, "applicationId": 4, "application": { "audit": { "created": { "date": "2017-08-03T21:48:25.994Z" }, "updated": {} }, "id": 4, "name": "App1", "description": null, "coreServicesId": "9437726c426b41c8ac11d38445caf218", "url": null }, "tierId": 39, "tier": { "audit": { "created": { "date": "2017-07-19T20:46:22.146Z" }, "updated": {} }, "id": 39, "name": "voluptatem 39", "description": "et in non inventore blanditiis voluptas voluptatem enim et\nculpa accusamus corporis\nvoluptas et dolorem ipsa", "limits": [ { "maximumRequests": 100000, "timePeriodInMilliseconds": 2592000000, "visible": false } ], "status": "ACTIVE", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "partyId": "1", "partyName": "hola", "apiId": 25, "api": { "audit": { "created": {}, "updated": {} }, "id": 25 } } ] } }

Create an API group contract createApiInstanceGroupContract

POST

Try it out

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

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
Examples
application/json
{ "name": "Example Resource", "description": "Example description" }

Response

The new element has been successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

List API contracts listApiInstanceContracts

GET

Try it out

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

Connected Apps require the following scopes:
- View Contracts

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Query Parameters

includeExtraApplicationData: any
When true, includes additional metadata about the client applications in the response. Defaults to false.
includeExtraRedirections: any
When true, includes OAuth redirect URI information for each application. Defaults to false.
coreServicesId: string
Filter contracts by the core services identifier of the client application.
status: string
Filter contracts by status (e.g., approved, pending, revoked).
offset: integer
limit: integer
sort: string
Property to sort by.
ascending: any
Order for sorting.
query: string
Search criteria.

Response

json
Success. Returns the requested resource.
total: number
contracts: array
Examples
Contracts
{ "value": { "total": 2, "contracts": [ { "audit": { "created": { "date": "2017-07-19T20:46:22.440Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 24, "status": "APPROVED", "approvedDate": "2017-07-19T20:46:22.520Z", "rejectedDate": null, "revokedDate": null, "applicationId": 1, "application": { "audit": { "created": { "date": "2017-07-19T20:46:19.307Z" }, "updated": {} }, "id": 1, "name": "dolor 1", "description": "repudiandae quo ab veritatis recusandae consequatur perferendis delectus corporis illo rerum officia quia quaerat ut dolorem eos illum optio odio alias amet nihil consequatur et et reprehenderit voluptate vel ipsa corrupti et dicta sint minus rerum culpa rerum labore temporibus qui dolores porro dolor quam molestias ea est aliquid nam", "coreServicesId": "98ecdda9dc524b37b141e2cc3ee19747", "url": "http://sample-app.com/1" }, "tierId": 48, "tier": { "audit": { "created": { "date": "2017-07-19T20:46:22.197Z" }, "updated": {} }, "id": 48, "name": "magni 48", "description": "incidunt sit eius vel quo qui qui ex et\nrerum possimus laudantium fugit minima aut perferendis\nmaiores dolore tempore non", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": true } ], "status": "DEPRECATED", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "partyId": null, "partyName": null, "apiId": 25, "api": { "audit": { "created": {}, "updated": {} }, "id": 25 } }, { "audit": { "created": { "date": "2017-08-03T22:13:14.533Z" }, "updated": { "date": "2017-08-03T22:16:36.673Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 77, "status": "APPROVED", "approvedDate": "2017-08-03T22:16:36.673Z", "rejectedDate": null, "revokedDate": null, "applicationId": 4, "application": { "audit": { "created": { "date": "2017-08-03T21:48:25.994Z" }, "updated": {} }, "id": 4, "name": "App1", "description": null, "coreServicesId": "9437726c426b41c8ac11d38445caf218", "url": null }, "tierId": 39, "tier": { "audit": { "created": { "date": "2017-07-19T20:46:22.146Z" }, "updated": {} }, "id": 39, "name": "voluptatem 39", "description": "et in non inventore blanditiis voluptas voluptatem enim et\nculpa accusamus corporis\nvoluptas et dolorem ipsa", "limits": [ { "maximumRequests": 100000, "timePeriodInMilliseconds": 2592000000, "visible": false } ], "status": "ACTIVE", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "partyId": "1", "partyName": "hola", "apiId": 25, "api": { "audit": { "created": {}, "updated": {} }, "id": 25 } } ] } }

Create an API contract createApiInstanceContract

POST

Try it out

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

Connected Apps require the following scopes:
- Manage Contracts
- Exchange Viewer

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
requestedTierId: integer
applicationId *: integer
requestAccessInfo: object
Examples
Contract
{ "value": { "applicationId": 3, "partyId": "", "partyName": "", "acceptedTerms": false, "requestedTierId": 48, "requestAccessInfo": { "reason": "This is the request reason" } } }

Response

json
The new element has been successfully created.
audit: object
masterOrganizationId: string
organizationId: string
id: number
status: string
approvedDate: string
rejectedDate:
revokedDate:
applicationId: number
application: object
tierId: number
tier: object
requestedTierId:
requestedTier:
terms:
partyId: string
partyName: string
requestAccessInfo: object
apiId: number
api: object
Examples
Contract
{ "value": { "audit": { "created": { "date": "2017-08-07T16:42:32.872Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 80, "status": "APPROVED", "approvedDate": "2017-08-07T16:42:32.907Z", "rejectedDate": null, "revokedDate": null, "applicationId": 3, "application": { "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 3, "name": "veritatis 3", "description": "omnis temporibus voluptas cumque ut quia quas commodi officiis doloremque deserunt tempore qui veritatis qui porro ut modi eos consequatur possimus accusamus perferendis a sunt nulla quos laudantium iste voluptas odio blanditiis aliquam aliquid iusto esse dicta neque fugit cupiditate beatae aut quae sint eos sequi numquam ab quo rem", "coreServicesId": "a81fca28ebaa4001bc2426350f207a53", "url": "http://sample-app.com/3", "grantTypes": [], "redirectUri": [ "http://sample-app.com/3/redirect" ], "clientId": "a81fca28ebaa4001bc2426350f207a53", "clientSecret": "795F7A469Bf646289d742869B5d828d4", "clientProvider": { "providerId": null }, "owner": "N/A", "email": "N/A", "owners": [] }, "tierId": 48, "tier": { "audit": { "created": { "date": "2017-07-19T20:46:22.197Z" }, "updated": {} }, "id": 48, "name": "magni 48", "description": "incidunt sit eius vel quo qui qui ex et\nrerum possimus laudantium fugit minima aut perferendis\nmaiores dolore tempore non", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": true } ], "status": "DEPRECATED", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "partyId": "", "partyName": "", "requestAccessInfo": { "reason": "This is the request reason" }, "apiId": 25, "api": { "audit": { "created": {}, "updated": {} }, "id": 25 } } }

Get an API contract getApiInstanceContract

GET

Try it out

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

Connected Apps require the following scopes:
- View Contracts

Path Parameters

contractId *: string
environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

json
Success. Returns the requested resource.
total: number
contracts: array
Examples
Contracts
{ "value": { "total": 2, "contracts": [ { "audit": { "created": { "date": "2017-07-19T20:46:22.440Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 24, "status": "APPROVED", "approvedDate": "2017-07-19T20:46:22.520Z", "rejectedDate": null, "revokedDate": null, "applicationId": 1, "application": { "audit": { "created": { "date": "2017-07-19T20:46:19.307Z" }, "updated": {} }, "id": 1, "name": "dolor 1", "description": "repudiandae quo ab veritatis recusandae consequatur perferendis delectus corporis illo rerum officia quia quaerat ut dolorem eos illum optio odio alias amet nihil consequatur et et reprehenderit voluptate vel ipsa corrupti et dicta sint minus rerum culpa rerum labore temporibus qui dolores porro dolor quam molestias ea est aliquid nam", "coreServicesId": "98ecdda9dc524b37b141e2cc3ee19747", "url": "http://sample-app.com/1" }, "tierId": 48, "tier": { "audit": { "created": { "date": "2017-07-19T20:46:22.197Z" }, "updated": {} }, "id": 48, "name": "magni 48", "description": "incidunt sit eius vel quo qui qui ex et\nrerum possimus laudantium fugit minima aut perferendis\nmaiores dolore tempore non", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": true } ], "status": "DEPRECATED", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "partyId": null, "partyName": null, "apiId": 25, "api": { "audit": { "created": {}, "updated": {} }, "id": 25 } }, { "audit": { "created": { "date": "2017-08-03T22:13:14.533Z" }, "updated": { "date": "2017-08-03T22:16:36.673Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 77, "status": "APPROVED", "approvedDate": "2017-08-03T22:16:36.673Z", "rejectedDate": null, "revokedDate": null, "applicationId": 4, "application": { "audit": { "created": { "date": "2017-08-03T21:48:25.994Z" }, "updated": {} }, "id": 4, "name": "App1", "description": null, "coreServicesId": "9437726c426b41c8ac11d38445caf218", "url": null }, "tierId": 39, "tier": { "audit": { "created": { "date": "2017-07-19T20:46:22.146Z" }, "updated": {} }, "id": 39, "name": "voluptatem 39", "description": "et in non inventore blanditiis voluptas voluptatem enim et\nculpa accusamus corporis\nvoluptas et dolorem ipsa", "limits": [ { "maximumRequests": 100000, "timePeriodInMilliseconds": 2592000000, "visible": false } ], "status": "ACTIVE", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "partyId": "1", "partyName": "hola", "apiId": 25, "api": { "audit": { "created": {}, "updated": {} }, "id": 25 } } ] } }

Update API contract conditions updateApiInstanceContract

PATCH

Try it out

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

Connected Apps require the following scopes:
- Manage Contracts
- Exchange Viewer

Path Parameters

contractId *: string
environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
tierId: integer
requestedTierId: integer
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

json
Success. Returns the requested resource.
audit: object
masterOrganizationId: string
organizationId: string
id: number
status: string
approvedDate: string
rejectedDate:
revokedDate:
applicationId: number
application: object
tierId: number
tier: object
requestedTierId:
requestedTier:
terms:
partyId: string
partyName: string
requestAccessInfo: object
apiId: number
api: object
Examples
Contract
{ "value": { "audit": { "created": { "date": "2017-08-07T16:42:32.872Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 80, "status": "APPROVED", "approvedDate": "2017-08-07T16:42:32.907Z", "rejectedDate": null, "revokedDate": null, "applicationId": 3, "application": { "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 3, "name": "veritatis 3", "description": "omnis temporibus voluptas cumque ut quia quas commodi officiis doloremque deserunt tempore qui veritatis qui porro ut modi eos consequatur possimus accusamus perferendis a sunt nulla quos laudantium iste voluptas odio blanditiis aliquam aliquid iusto esse dicta neque fugit cupiditate beatae aut quae sint eos sequi numquam ab quo rem", "coreServicesId": "a81fca28ebaa4001bc2426350f207a53", "url": "http://sample-app.com/3", "grantTypes": [], "redirectUri": [ "http://sample-app.com/3/redirect" ], "clientId": "a81fca28ebaa4001bc2426350f207a53", "clientSecret": "795F7A469Bf646289d742869B5d828d4", "clientProvider": { "providerId": null }, "owner": "N/A", "email": "N/A", "owners": [] }, "tierId": 48, "tier": { "audit": { "created": { "date": "2017-07-19T20:46:22.197Z" }, "updated": {} }, "id": 48, "name": "magni 48", "description": "incidunt sit eius vel quo qui qui ex et\nrerum possimus laudantium fugit minima aut perferendis\nmaiores dolore tempore non", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": true } ], "status": "DEPRECATED", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "partyId": "", "partyName": "", "requestAccessInfo": { "reason": "This is the request reason" }, "apiId": 25, "api": { "audit": { "created": {}, "updated": {} }, "id": 25 } } }

Delete an API contract deleteApiInstanceContract

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes the contract

Connected Apps require the following scopes:
- Manage Contracts

Path Parameters

contractId *: string
environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

No Content. The operation completed successfully with no response body.

List API alerts listApiInstanceAlerts

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of API alerts

Connected Apps require the following scopes:
- Manage API Alerts

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

json
Successfully retrieved an API's alert definitions.
items: array
Array items
Examples
Contract
{ "value": [ { "apiAlertsVersion": "1.0.0", "api": { "id": 24, "name": "ad 24" }, "condition": { "aggregate": "COUNT", "operator": "GREATER_THAN", "value": 90, "resourceType": "api" }, "createdAt": 1501526157101, "enabled": true, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "id": "a54e3a66-489b-43d9-895f-183837bc82a4", "lastModified": 1501526157101, "name": "REQUEST COUNT ALERT", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "period": { "repeat": 5, "duration": { "count": 5, "weight": "DAYS" } }, "recipients": [ { "type": "user", "value": "57e281b5-ec5b-4701-80a0-92a936a68da3", "lastName": "Owner", "firstName": "Organization" } ], "severity": "CRITICAL", "type": "api-request-count" } ] }

Create an API alert createApiInstanceAlert

POST

Try it out

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

Connected Apps require the following scopes:
- Manage API Alerts

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
recipients: array
Examples
Alert
{ "value": { "apiAlertsVersion": "1.0.0", "condition": { "aggregate": "COUNT", "operator": "GREATER_THAN", "value": 90, "resourceType": "api" }, "enabled": true, "name": "some alert name", "period": { "repeat": 5, "duration": { "count": 5, "weight": "DAYS" } }, "recipients": [ { "type": "user", "value": "57e281b5-ec5b-4701-80a0-92a936a68da3", "lastName": "Owner", "firstName": "Organization" } ], "severity": "CRITICAL", "type": "api-request-count" } }

Response

json
Successfully created alert definition.
items: array
Array items
Examples
Contract
{ "value": [ { "apiAlertsVersion": "1.0.0", "api": { "id": 24, "name": "ad 24" }, "condition": { "aggregate": "COUNT", "operator": "GREATER_THAN", "value": 90, "resourceType": "api" }, "createdAt": 1501526157101, "enabled": true, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "id": "a54e3a66-489b-43d9-895f-183837bc82a4", "lastModified": 1501526157101, "name": "REQUEST COUNT ALERT", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "period": { "repeat": 5, "duration": { "count": 5, "weight": "DAYS" } }, "recipients": [ { "type": "user", "value": "57e281b5-ec5b-4701-80a0-92a936a68da3", "lastName": "Owner", "firstName": "Organization" } ], "severity": "CRITICAL", "type": "api-request-count" } ] }

Get an API alert getApiInstanceAlert

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves an API alert

Connected Apps require the following scopes:
- Manage API Alerts

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string
alertId *: string

Response

json
Successfully retrieved alert definition.
apiAlertsVersion: string
api: object
condition: object
createdAt: number
enabled: boolean
environmentId: string
id: string
lastModified: number
name: string
organizationId: string
period: object
recipients: array
severity: string
type: string
Examples
Contract
{ "value": { "apiAlertsVersion": "1.0.0", "api": { "id": 95, "name": "alerts" }, "condition": { "aggregate": "COUNT", "operator": "GREATER_THAN", "value": 90, "resourceType": "api" }, "createdAt": 1502053776408, "enabled": true, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "id": "1e2a174f-162b-4803-ab74-fb8d5feeaf86", "lastModified": 1502053776408, "name": "some alert name", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "period": { "repeat": 5, "duration": { "count": 5, "weight": "DAYS" } }, "recipients": [ { "type": "user", "value": "57e281b5-ec5b-4701-80a0-92a936a68da3", "lastName": "Owner", "firstName": "Organization" } ], "severity": "CRITICAL", "type": "api-request-count" } }

Update an API alert updateApiInstanceAlert

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates an API alert

Connected Apps require the following scopes:
- Manage API Alerts

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string
alertId *: string

Request Body *

json
recipients: array
Examples
Alert
{ "value": { "apiAlertsVersion": "1.0.0", "condition": { "aggregate": "COUNT", "operator": "GREATER_THAN", "value": 90, "resourceType": "api" }, "enabled": true, "name": "some alert name", "period": { "repeat": 5, "duration": { "count": 5, "weight": "DAYS" } }, "recipients": [ { "type": "user", "value": "57e281b5-ec5b-4701-80a0-92a936a68da3", "lastName": "Owner", "firstName": "Organization" } ], "severity": "CRITICAL", "type": "api-request-count" } }

Response

json
Successfully updated alert definition.
apiAlertsVersion: string
api: object
condition: object
createdAt: number
enabled: boolean
environmentId: string
id: string
lastModified: number
name: string
organizationId: string
period: object
recipients: array
severity: string
type: string
Examples
Contract
{ "value": { "apiAlertsVersion": "1.0.0", "api": { "id": 95, "name": "alerts" }, "condition": { "aggregate": "COUNT", "operator": "GREATER_THAN", "value": 90, "resourceType": "api" }, "createdAt": 1502053776408, "enabled": true, "environmentId": "b0f02fea-b5e9-4bf1-aef8-a2d4027eca5d", "id": "1e2a174f-162b-4803-ab74-fb8d5feeaf86", "lastModified": 1502053776408, "name": "some alert name", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "period": { "repeat": 5, "duration": { "count": 5, "weight": "DAYS" } }, "recipients": [ { "type": "user", "value": "57e281b5-ec5b-4701-80a0-92a936a68da3", "lastName": "Owner", "firstName": "Organization" } ], "severity": "CRITICAL", "type": "api-request-count" } }

Delete an API alert deleteApiInstanceAlert

DELETE

Try it out

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

Connected Apps require the following scopes:
- Manage API Alerts

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string
alertId *: string

Response

Successfully deleted alert definition.

Export the API bundle exportApiInstanceBundle

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
A zip with all the api's information - Equivalent to exporting the api

Connected Apps require the following scopes:
- View APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Query Parameters

slaTiers: any
endpoint: any
omitPoliciesWithSensitiveFields: any

Response

Success. Returns the requested resource.
Examples
application/json
{ "total": 0, "data": [] }

Add a new API tag addApiInstanceTag

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Adds a new API tag

Connected Apps require the following scopes:
- Manage APIs Configuration

Path Parameters

tag *: string
The tag to identify the target resource.
environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

Created. The resource was successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Delete an API tag deleteApiInstanceTag

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes an API tag

Connected Apps require the following scopes:
- Manage APIs Configuration

Path Parameters

tag *: string
The tag to identify the target resource.
environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

No Content. The operation completed successfully with no response body.

Get API autodiscovery properties getApiInstanceAutodiscoveryProperties

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets the autodiscovery properties required for a gateway to track the API

Connected Apps require the following scopes:
- View APIs Configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Query Parameters

gatewayVersion *: string
The version of the gateway that will use the autodiscovery properties to track this API, written in semver.

Response

Success. Returns the requested resource.
Examples
application/json
{ "total": 0, "data": [] }

Get API TLS context configuration getApiInstanceTlsContexts

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves TLS Contexts configuration for a given API endpoint

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

json
Successful
audit: object
id: number
organizationId: string
masterOrganizationId: string
inbound: object
outbound:
Examples
Tls
{ "value": { "audit": { "created": { "date": "2018-10-04T18:54:11.844Z" }, "updated": { "date": "2018-10-04T18:55:59.952Z" } }, "id": 9, "organizationId": "r0c4b021-980e-4928-9430-e60e3a97c789", "masterOrganizationId": "r0c4b021-980e-4928-9430-e60e3a97c789", "inbound": { "secretGroupId": "8f5c4947-feea-4683-aa38-42ad97584d51", "tlsContextId": "1d3b677a-7c9f-4c9b-b143-cf257835f9a8" }, "outbound": null } }

Create API TLS context configuration createApiInstanceTlsContexts

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates TLS Contexts configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
Examples
Tls
{ "value": { "inbound": { "secretGroupId": "8f5c4947-feea-4683-aa38-42ad97584d51", "tlsContextId": "1d3b677a-7c9f-4c9b-b143-cf257835f9a8" }, "outbound": { "secretGroupId": "8f5c4947-feea-4683-aa38-42ad97584d51", "tlsContextId": "1d3b677a-7c9f-4c9b-b143-cf257835f9a8" } } }

Response

TLS Contexts configuration was created successfully
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Update API TLS context configuration updateApiInstanceTlsContexts

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates TLS Contexts configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Request Body *

json
Examples
Tls
{ "value": { "inbound": { "secretGroupId": "8f5c4947-feea-4683-aa38-42ad97584d51", "tlsContextId": "1d3b677a-7c9f-4c9b-b143-cf257835f9a8" }, "outbound": { "secretGroupId": "8f5c4947-feea-4683-aa38-42ad97584d51", "tlsContextId": "1d3b677a-7c9f-4c9b-b143-cf257835f9a8" } } }

Response

TLS Contexts configuration was successfully updated
Examples
application/json
{ "message": "Resource updated successfully" }

Delete API TLS context configuration deleteApiInstanceTlsContexts

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes TLS Contexts configuration

Path Parameters

environmentApiId *: integer
organizationId *: string
environmentId *: string

Response

TLS Contexts successfully deleted

List group instances listGroupInstances

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets a list of group istances by environmentId

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string

Response

Success. Returns the requested resource.
Examples
application/json
{ "total": 0, "data": [] }

Create a group instance createGroupInstance

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a Group instance

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string

Request Body *

json
groupId: integer
groupVersionId: integer
status: string
groupInstanceLabel: string | null
apiInstances *: array
deprecated: boolean
promote: object
Examples
GroupContract
{ "value": { "groupId": 1, "groupVersionId": 2, "groupInstanceLabel": "prod", "apiInstances": [ 3, 17 ], "status": "DRAFT" } }

Response

Group instance was created successfully
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Get a group instance getGroupInstance

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets a group instance

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

Successful
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "name": "Example Resource" }

Update a group instance updateGroupInstance

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a group instance

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string
groupInstanceId *: integer

Request Body *

json
status: string
groupInstanceLabel: string | null
apiInstances: array
deprecated: boolean
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

Success. Returns the requested resource.
Examples
application/json
{ "message": "Resource updated successfully" }

Delete a group instance deleteGroupInstance

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a group instance

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

Created. The resource was successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

List group instance contracts listGroupInstanceContracts

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the list of contracts of a group instances

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

json
Success. Returns the requested resource.
total: number
contracts: array
Examples
GroupContract
{ "value": { "total": 1, "contracts": [ { "audit": { "created": { "date": "2019-06-10T17:59:22.648Z" }, "updated": {} }, "masterOrganizationId": "df698af3-9b43-4a73-91b2-643dc774b88f", "organizationId": "df698af3-9b43-4a73-91b2-643dc774b88f", "id": 90161, "status": "APPROVED", "approvedDate": "2019-06-10T17:59:22.743Z", "rejectedDate": null, "revokedDate": null, "applicationId": 95543, "application": { "audit": { "created": { "date": "2019-01-25T18:13:39.391Z" }, "updated": {} }, "id": 95543, "name": "testApp", "description": null, "coreServicesId": "08e71e20c16946ca886551c2bc1ef15a", "url": null }, "tier": null, "tierId": null, "requestedTierId": null, "requestedTier": null, "terms": null, "groupInstanceId": 193283, "groupInstances": { "audit": { "created": {}, "updated": {} }, "id": 193283, "groupVersionId": 1073, "organizationId": "df698af3-9b43-4a73-91b2-643dc774b88f", "environmentId": "22126179-3dae-43f5-ac23-cbc9ecc29c53", "assetGroupId": null, "assetId": null, "assetVersion": null, "groupInstanceLabel": null }, "partyId": null, "partyName": null, "condition": "GROUP" } ] } }

Create a group instance contract createGroupInstanceContract

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates new contract between a group instance and a application

Connected Apps require the following scopes:
- API Group Administrator
- Exchange Viewer

Path Parameters

organizationId *: string
environmentId *: string
groupInstanceId *: integer

Request Body *

json
requestedTierId: integer
applicationId *: integer
requestAccessInfo: object
Examples
Contract
{ "value": { "applicationId": 3, "partyId": "", "partyName": "", "acceptedTerms": false, "requestedTierId": 48, "requestAccessInfo": { "reason": "This is the request reason" } } }

Response

json
The new element has been successfully created.
audit: object
masterOrganizationId: string
organizationId: string
id: number
status: string
approvedDate: string
rejectedDate:
revokedDate:
applicationId: number
application: object
tierId: number
tier: object
requestedTierId:
requestedTier:
terms:
partyId: string
partyName: string
groupInstanceId: number
groupInstance: object
Examples
Contract
{ "value": { "audit": { "created": { "date": "2017-08-07T16:42:32.872Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 80, "status": "APPROVED", "approvedDate": "2017-08-07T16:42:32.907Z", "rejectedDate": null, "revokedDate": null, "applicationId": 3, "application": { "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 3, "name": "veritatis 3", "description": "omnis temporibus voluptas cumque ut quia quas commodi officiis doloremque deserunt tempore qui veritatis qui porro ut modi eos consequatur possimus accusamus perferendis a sunt nulla quos laudantium iste voluptas odio blanditiis aliquam aliquid iusto esse dicta neque fugit cupiditate beatae aut quae sint eos sequi numquam ab quo rem", "coreServicesId": "a81fca28ebaa4001bc2426350f207a53", "url": "http://sample-app.com/3", "grantTypes": [], "redirectUri": [ "http://sample-app.com/3/redirect" ], "clientId": "a81fca28ebaa4001bc2426350f207a53", "clientSecret": "795F7A469Bf646289d742869B5d828d4", "clientProvider": { "providerId": null }, "owner": "N/A", "email": "N/A", "owners": [] }, "tierId": 48, "tier": { "audit": { "created": { "date": "2017-07-19T20:46:22.197Z" }, "updated": {} }, "id": 48, "name": "magni 48", "description": "incidunt sit eius vel quo qui qui ex et\nrerum possimus laudantium fugit minima aut perferendis\nmaiores dolore tempore non", "limits": [ { "maximumRequests": 1000000, "timePeriodInMilliseconds": 1000, "visible": true } ], "status": "DEPRECATED", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "partyId": "", "partyName": "", "groupInstanceId": 25, "groupInstance": { "audit": { "created": { "date": "2017-08-07T16:42:32.872Z" }, "updated": {} }, "id": 25, "groupId": 1066, "groupVersionId": 1073, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "environmentId": "22126179-3dae-43f5-ac23-cbc9ecc29c53", "assetGroupId": null, "assetId": null, "assetVersion": null, "productVersion": null, "groupInstanceLabel": null, "status": "DRAFT", "deprecated": false, "apiInstances": [ 312440 ] } } }

Count group instance contracts checkGroupInstanceContracts

HEAD

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the count of contracts of a group instances

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

Success. Returns the requested resource.

Get a group instance contract getGroupInstanceContract

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a specific contract for the group instance

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

contractId *: string
organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

json
Success. Returns the requested resource.
total: number
contracts: array
Examples
GroupContract
{ "value": { "total": 1, "contracts": [ { "audit": { "created": { "date": "2019-06-10T17:59:22.648Z" }, "updated": {} }, "masterOrganizationId": "df698af3-9b43-4a73-91b2-643dc774b88f", "organizationId": "df698af3-9b43-4a73-91b2-643dc774b88f", "id": 90161, "status": "APPROVED", "approvedDate": "2019-06-10T17:59:22.743Z", "rejectedDate": null, "revokedDate": null, "applicationId": 95543, "application": { "audit": { "created": { "date": "2019-01-25T18:13:39.391Z" }, "updated": {} }, "id": 95543, "name": "testApp", "description": null, "coreServicesId": "08e71e20c16946ca886551c2bc1ef15a", "url": null }, "tier": null, "tierId": null, "requestedTierId": null, "requestedTier": null, "terms": null, "groupInstanceId": 193283, "groupInstances": { "audit": { "created": {}, "updated": {} }, "id": 193283, "groupVersionId": 1073, "organizationId": "df698af3-9b43-4a73-91b2-643dc774b88f", "environmentId": "22126179-3dae-43f5-ac23-cbc9ecc29c53", "assetGroupId": null, "assetId": null, "assetVersion": null, "groupInstanceLabel": null }, "partyId": null, "partyName": null, "condition": "GROUP" } ] } }

Update a group instance contract updateGroupInstanceContract

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Updates a group instance contract

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

contractId *: string
organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

Success. Returns the requested resource.
Examples
application/json
{ "message": "Resource updated successfully" }

Delete a group instance contract deleteGroupInstanceContract

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a group instance contract that is not currently applied

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

contractId *: string
organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

No Content. The operation completed successfully with no response body.

List group instance tiers listGroupInstanceTiers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the tiers of a Group instance

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

json
Successful
total: number
tiers: array
Examples
GroupTier
{ "value": { "total": 1, "tiers": [ { "audit": { "created": { "date": "2017-08-04T15:11:13.070Z" }, "updated": {} }, "masterOrganizationId": "40fbc081-bb0d-4aff-9fb7-f3a48fdeb958", "organizationId": "643c5d65-93ab-404d-9c13-efab34cf2a60", "id": 23, "groupInstanceId": 34, "name": "Free", "description": "This is some description text", "defaultLimits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "limitsByApi": [ { "apiId": 2, "limits": [ { "maximumRequests": 100000, "timePeriodInMilliseconds": 86400000, "visible": false }, { "maximumRequests": 1000000, "timePeriodInMilliseconds": 604800000, "visible": true } ] }, { "apiId": 3, "limits": [ { "maximumRequests": 10, "timePeriodInMilliseconds": 86400000, "visible": true }, { "maximumRequests": 1000000, "timePeriodInMilliseconds": 2592000000, "visible": true } ] } ], "status": "ACTIVE", "autoApprove": false, "applicationCount": 0 } ] } }

Create a group instance tier createGroupInstanceTier

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a Group instance tier

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string
groupInstanceId *: integer

Request Body *

json
groupInstanceId: integer
name *: string
description: string | null
autoApprove: boolean
status *: string
defaultLimits: array
limitsByApi: array
Examples
GroupTier
{ "value": { "status": "ACTIVE", "autoApprove": true, "limitsByApi": [ { "apiId": 3, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ] } ], "name": "tierName", "description": "tier description" } }

Response

json
Successful
status: string
autoApprove: boolean
defaultLimits: array
limitsByApi: array
groupInstanceId: number
name: string
description: string
audit: object
id: number
Examples
GroupTier
{ "value": { "status": "ACTIVE", "autoApprove": true, "defaultLimits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "limitsByApi": [ { "apiId": 3, "groupId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "assetId": "facebook-api", "assetVersion": "1.0.0", "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ] } ], "groupInstanceId": 1072, "name": "tierName", "description": "tier description", "audit": { "created": "", "updated": "" }, "id": 131529 } }

Get a group instance tier getGroupInstanceTier

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a group instance tier

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

tierId *: integer
organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

json
Succesful
status: string
autoApprove: boolean
defaultLimits: array
limitsByApi: array
name: string
description: string
masterOrganizationId: string
organizationId: string
id: number
groupInstanceId: number
applicationCount: number
audit: object
Examples
GroupTier
{ "value": { "status": "ACTIVE", "autoApprove": true, "defaultLimits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "limitsByApi": [ { "apiId": 3, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ] } ], "name": "tierName", "description": "tier description", "masterOrganizationId": "dba62d01-b878-4816-a908-9703bd0c1fac", "organizationId": "dba62d01-b878-4816-a908-9703bd0c1fac", "id": 131529, "groupInstanceId": 1072, "applicationCount": 0, "audit": { "created": "", "updated": "" } } }

Replace a group instance tier updateGroupInstanceTier

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a group instance tier

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

tierId *: integer
organizationId *: string
environmentId *: string
groupInstanceId *: integer

Request Body *

json
id: integer
groupVersionId: integer
name *: string
description: string | null
autoApprove: boolean
status *: string
defaultLimits: array
limitsByApi: array
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

json
Succesful
status: string
autoApprove: boolean
defaultLimits: array
limitsByApi: array
name: string
description: string
masterOrganizationId: string
organizationId: string
id: number
groupInstanceId: number
applicationCount: number
audit: object
Examples
GroupTier
{ "value": { "status": "ACTIVE", "autoApprove": true, "defaultLimits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "limitsByApi": [ { "apiId": 3, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ] } ], "name": "tierName", "description": "tier description", "masterOrganizationId": "dba62d01-b878-4816-a908-9703bd0c1fac", "organizationId": "dba62d01-b878-4816-a908-9703bd0c1fac", "id": 131529, "groupInstanceId": 1072, "applicationCount": 0, "audit": { "created": "", "updated": "" } } }

Update a group instance tier patchGroupInstanceTier

PATCH

Try it out

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

Path Parameters

tierId *: integer
organizationId *: string
environmentId *: string
groupInstanceId *: integer

Request Body *

json
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

Success. Returns the requested resource.
Examples
application/json
{ "message": "Resource updated successfully" }

Delete a group instance tier deleteGroupInstanceTier

DELETE

Try it out

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

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

tierId *: integer
organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

The element has been deleted successfully.

List group instance APIs listGroupInstanceApiInstances

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets API instances of a group instances

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string
environmentId *: string
groupInstanceId *: integer

Response

Success. Returns the requested resource.
Examples
application/json
{ "total": 0, "data": [] }

List managed service APIs listManagedServiceApis

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a collection of Managed Service APIs in the specified environment.
Managed Service APIs are deployed and managed through API Manager's service
mesh capabilities.

Path Parameters

organizationId *: string
environmentId *: string

Response

json
Success. Returns the requested resource.
managedServiceApis: array
total: number
Examples
ApiList
{ "value": { "managedServiceApis": [ { "audit": { "created": { "date": "2020-09-07T13:57:59.194Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 123, "providerId": null, "endpointUri": "http://graph.example.com/api", "environmentId": "ee737db1-b6a3-4d17-8f45-3f8c4a53b699", "instanceLabel": null, "endpoint": { "uri": "http://mygraph.cloudhub.io/api" } } ], "total": 1 } }

Get a managed service API getManagedServiceApi

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve a specific Managed Service API

Path Parameters

organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Response

json
Success. Returns the requested resource.
audit: object
masterOrganizationId: string
organizationId: string
id: number
providerId:
endpointUri: string
environmentId: string
instanceLabel:
endpoint: object
Examples
Api
{ "value": { "audit": { "created": { "date": "2020-12-11T14:10:27.146Z" }, "updated": {} }, "masterOrganizationId": "070659af-a980-4d20-85fe-206102776980", "organizationId": "070659af-a980-4d20-85fe-206102776980", "id": 1, "providerId": null, "endpointUri": "example.com", "environmentId": "b90acb62-8d59-4d86-ad80-fc7aeaebe1e4", "instanceLabel": null, "endpoint": { "uri": "http://my.api.com" } } }

Update managed service API details updateManagedServiceApi

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates endpointUri and providerId of managed service API.

Path Parameters

organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Request Body *

json
id: integer
endpoint: object
endpointUri: string | null
providerId: string | null
name: string
organizationId: string
masterOrganizationId: string
environmentId: string
audit: object
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

json
Success. Returns the requested resource.
audit: object
masterOrganizationId: string
organizationId: string
id: number
providerId:
endpointUri: string
environmentId: string
endpoint: object
Examples
Api
{ "value": { "audit": { "created": { "date": "2020-09-07T13:57:59.194Z" }, "updated": { "date": "2020-09-24T14:14:29.120Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 123, "providerId": null, "endpointUri": "http://graph.example.com/api", "environmentId": "ee737db1-b6a3-4d17-8f45-3f8c4a53b699", "endpoint": { "uri": "http://mygraph.cloudhub.io/api" } } }

List managed service API policies listManagedServiceApiPolicies

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves all policies applied to a specific Managed Service API.
Returns the policy configuration including order, enabled status, and configuration
parameters.

Path Parameters

organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Query Parameters

fullInfo: any

Header Parameters

if-none-match: number
Last modification date (EPOC)

Response

json
Success. Returns the requested resource.
items: array
Array items
Examples
Policies
{ "value": [ { "configurationData": { "credentialsOriginHasHttpBasicAuthenticationHeader": "customExpression", "clientIdExpression": "#[attributes.headers['client_id']]", "clientSecretExpression": "#[attributes.headers['client_secret']]" }, "pointcutData": null, "policyTemplateId": "2", "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "assetId": "client-id-enforcement", "assetVersion": "1.1.1", "order": 1, "audit": { "created": { "date": "2020-10-23T13: 44: 40.104Z" }, "updated": {} }, "masterOrganizationId": "798a8f89-9f73-4a9f-ab46-7f17e3523834", "organizationId": "798a8f89-9f73-4a9f-ab46-7f17e3523834", "id": 31804, "managedServiceApiId": 14998 } ] }

Create a managed service API policy createManagedServiceApiPolicy

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a Managed Service API Policy

Path Parameters

organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Request Body *

json
groupId *: string
assetId *: string
assetVersion *: string
configurationData: object | array
order: integer
Examples
application/json
{ "name": "Example Resource", "description": "Example description" }

Response

json
Created. The resource was successfully created.
configurationData: object
pointcutData:
policyTemplateId: string
groupId: string
assetId: string
assetVersion: string
order: number
audit: object
masterOrganizationId: string
organizationId: string
id: number
managedServiceApiId: number
Examples
Policy
{ "value": { "configurationData": { "credentialsOriginHasHttpBasicAuthenticationHeader": "customExpression", "clientIdExpression": "#[attributes.headers['client_id']]", "clientSecretExpression": "#[attributes.headers['client_secret']]" }, "pointcutData": null, "policyTemplateId": "2", "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "assetId": "client-id-enforcement", "assetVersion": "1.1.1", "order": 1, "audit": { "created": { "date": "2020-10-23T13: 44: 40.104Z" }, "updated": {} }, "masterOrganizationId": "798a8f89-9f73-4a9f-ab46-7f17e3523834", "organizationId": "798a8f89-9f73-4a9f-ab46-7f17e3523834", "id": 31804, "managedServiceApiId": 14998 } }

Get a managed service API policy getManagedServiceApiPolicy

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves details of a specific policy applied to a Managed Service API.
Returns the complete policy configuration including template information and
parameter values.

Path Parameters

policyId *: integer
organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Response

json
Success. Returns the requested resource.
assetId: string
assetVersion: string
audit: object
configurationData: object
disabled: boolean
groupId: string
id: number
managedServiceApiId: number
masterOrganizationId: string
order: number
organizationId: string
pointcutData:
policyTemplateId: string
Examples
Policy
{ "value": { "assetId": "client-id-enforcement", "assetVersion": "1.2.2", "audit": { "created": { "date": "2021-01-14T19:56:48.538Z" }, "updated": {} }, "configurationData": { "clientIdExpression": "#[attributes.headers['client_id']]", "clientSecretExpression": "#[attributes.headers['client_secret']]", "credentialsOriginHasHttpBasicAuthenticationHeader": "customExpression" }, "disabled": false, "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "id": 960668, "managedServiceApiId": 1148719, "masterOrganizationId": "a6490194-2d13-4d87-a42a-cee9eb39de4f", "order": 1, "organizationId": "a6490194-2d13-4d87-a42a-cee9eb39de4f", "pointcutData": null, "policyTemplateId": "1193" } }

Update a managed service API policy updateManagedServiceApiPolicy

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a Managed Service API Policy

Path Parameters

policyId *: integer
organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Request Body *

json
groupId: string
assetId: string
assetVersion: string
configurationData: object | array
order: integer
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

json
Success. Returns the requested resource.
configurationData: object
pointcutData:
policyTemplateId: string
groupId: string
assetId: string
assetVersion: string
disabled: boolean
audit: object
masterOrganizationId: string
organizationId: string
id: number
managedServiceApiId: number
Examples
Policy
{ "value": { "configurationData": { "credentialsOriginHasHttpBasicAuthenticationHeader": "customExpression", "clientIdExpression": "#[attributes.headers['client_id']]", "clientSecretExpression": "#[attributes.headers['client_secret']]" }, "pointcutData": null, "policyTemplateId": "2", "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "assetId": "client-id-enforcement", "assetVersion": "1.1.1", "disabled": false, "audit": { "created": { "date": "2020-10-23T13: 44: 40.104Z" }, "updated": {} }, "masterOrganizationId": "798a8f89-9f73-4a9f-ab46-7f17e3523834", "organizationId": "798a8f89-9f73-4a9f-ab46-7f17e3523834", "id": 31804, "managedServiceApiId": 14998 } }

Unapply a managed service API policy unapplyManagedServiceApiPolicy

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Unapplies a policy.

Path Parameters

policyId *: integer
organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Response

No Content. The operation completed successfully with no response body.

List managed service API tiers listManagedServiceApiTiers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the tiers of a Managed Service API

Path Parameters

organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Response

json
Success. Returns the requested resource.
total: number
tiers: array
Examples
Tiers
{ "value": { "total": 1, "tiers": [ { "audit": { "created": { "date": "2020-10-26T15:36:20.600Z" }, "updated": { "date": "2020-10-26T15:37:06.564Z" } }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 307, "name": "tier-1603726626", "description": "tier description", "limits": [ { "visible": true, "maximumRequests": 40, "timePeriodInMilliseconds": 1 } ], "status": "ACTIVE", "autoApprove": true, "applicationCount": 0, "managedServiceApiId": 193 } ] } }

Create a managed service API tier createManagedServiceApiTier

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a tier for a Managed Service API

Path Parameters

organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Request Body *

json
managedServiceApiId: integer
name *: string
description: string | null
autoApprove: boolean
status *: string
limits *: array
Examples
Tier
{ "value": { "status": "ACTIVE", "autoApprove": true, "managedServiceApiId": 193, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "name": "tier-name", "description": "tier description" } }

Response

json
Created. The resource was successfully created.
status: string
autoApprove: boolean
limits: array
name: string
description: string
audit: object
masterOrganizationId: string
organizationId: string
id: number
managedServiceApiId: number
Examples
Tier
{ "value": { "status": "ACTIVE", "autoApprove": true, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "name": "tier-1603812476", "description": "tier description", "audit": { "created": { "date": "2020-10-27T15:27:55.937Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 316, "managedServiceApiId": 193 } }

Edit a managed service API tier updateManagedServiceApiTier

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Edit a tier of a Managed Service API

Path Parameters

tierId *: integer
organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Request Body *

json
managedServiceApiId: integer
name: string
description: string | null
autoApprove: boolean
status: string
limits: array
Examples
Tier
{ "value": { "status": "ACTIVE", "autoApprove": true, "managedServiceApiId": 193, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "name": "tier-name", "description": "tier description" } }

Response

json
Created. The resource was successfully created.
status: string
autoApprove: boolean
limits: array
name: string
description: string
audit: object
masterOrganizationId: string
organizationId: string
id: number
managedServiceApiId: number
Examples
Tier
{ "value": { "status": "ACTIVE", "autoApprove": true, "limits": [ { "visible": true, "maximumRequests": 5, "timePeriodInMilliseconds": 1 } ], "name": "tier-1603812476", "description": "tier description", "audit": { "created": { "date": "2020-10-27T15:27:55.937Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 316, "managedServiceApiId": 193 } }

Delete a managed service API tier deleteManagedServiceApiTier

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete a tier of a Managed Service API

Path Parameters

tierId *: integer
organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Response

No Content. The operation completed successfully with no response body.

List managed service API contracts listManagedServiceApiContracts

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the contracts of a Managed Service API

Path Parameters

organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Response

json
Success. Returns the requested resource.
total: number
contracts: array
Examples
Contracts
{ "value": { "total": 1, "contracts": [ { "audit": { "created": { "date": "2020-10-28T19:44:29.541Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 130, "status": "APPROVED", "approvedDate": "2020-10-28T19:44:29.576Z", "rejectedDate": null, "revokedDate": null, "applicationId": 8, "application": { "audit": { "created": { "date": "2020-10-27T18:14:12.397Z" }, "updated": {} }, "id": 8, "name": "Client APP 1603822451", "description": "This is the description", "clientProvider": {}, "coreServicesId": "eea7e89a970f46818827c425918e6979", "url": "http://www.salesforce-app.com" }, "tierId": 307, "tier": { "audit": { "created": { "date": "2020-10-26T15:36:20.600Z" }, "updated": { "date": "2020-10-27T15:38:02.573Z" } }, "id": 307, "name": "tier-1603813082", "description": "tier description", "limits": [ { "visible": true, "maximumRequests": 40, "timePeriodInMilliseconds": 1 } ], "status": "ACTIVE", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "groupInstanceId": null, "groupInstance": null, "partyId": "", "partyName": "", "condition": "APPLIED", "managedServiceApi": { "audit": { "created": {}, "updated": {} }, "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 193 }, "managedServiceApiId": 193 } ] } }

Create a managed service API contract createManagedServiceApiContract

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a contract for a Managed Service API

Path Parameters

organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Request Body *

json
applicationId *: integer
requestedTierId: integer
requestAccessInfo: object
Examples
Contract
{ "value": { "applicationId": 8, "partyId": "", "partyName": "", "acceptedTerms": false, "requestedTierId": 307 } }

Response

json
Created. The resource was successfully created.
audit: object
masterOrganizationId: string
organizationId: string
id: number
status: string
approvedDate: string
rejectedDate:
revokedDate:
applicationId: number
application: object
tierId: number
tier: object
requestedTierId:
requestedTier:
terms:
groupInstanceId:
groupInstance:
partyId: string
partyName: string
condition: string
managedServiceApi: object
managedServiceApiId: number
Examples
Contract
{ "value": { "audit": { "created": { "date": "2020-10-28T19:44:29.541Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 130, "status": "APPROVED", "approvedDate": "2020-10-28T19:44:29.576Z", "rejectedDate": null, "revokedDate": null, "applicationId": 8, "application": { "audit": { "created": { "date": "2020-10-27T18:14:12.397Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 8, "name": "Client APP 1603822451", "description": "This is the description", "clientProvider": { "providerId": null }, "coreServicesId": "eea7e89a970f46818827c425918e6979", "url": "http://www.salesforce-app.com", "grantTypes": [], "redirectUri": [], "clientId": "eea7e89a970f46818827c425918e6979", "clientSecret": "24e4fdb4E0434a089470fa4487c7Ed2b", "owner": "Organization Owner", "email": "api.platform.qa+o_o@gmail.com", "owners": [ { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "createdAt": "2020-05-27T19:27:14.150Z", "updatedAt": "2020-10-28T19:40:18.311Z", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "phoneNumber": "111-111-1111", "idprovider_id": "mulesoft", "username": "organization_owner", "enabled": true, "deleted": false, "lastLogin": "2020-10-28T22:40:00.000Z", "roles": [ "cc43e20e-c04b-4c86-a29e-49ac7e7f8b58" ], "type": "host" } ] }, "tierId": 307, "tier": { "audit": { "created": { "date": "2020-10-26T15:36:20.600Z" }, "updated": { "date": "2020-10-27T15:38:02.573Z" } }, "id": 307, "name": "tier-1603813082", "description": "tier description", "limits": [ { "visible": true, "maximumRequests": 40, "timePeriodInMilliseconds": 1 } ], "status": "ACTIVE", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "groupInstanceId": null, "groupInstance": null, "partyId": "", "partyName": "", "condition": "APPLIED", "managedServiceApi": { "audit": { "created": { "date": "2020-10-16T18:32:19.562Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 193, "portalId": null, "description": null, "providerId": null, "rootFileId": null, "deprecated": false, "lastActiveDate": null, "endpointUri": "http://graph.hsbc.com/api", "environmentId": "b1bf299f-0590-4e00-83c6-b78bb3dc92ff", "isPublic": false, "termsDate": null, "endpoint": { "uri": "http://mygraph.cloudhub.io/api" }, "deployment": null, "permissions": { "update": true } }, "managedServiceApiId": 193 } }

Get a managed service API contract getManagedServiceApiContract

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a contract of a Managed Service API

Path Parameters

contractId *: string
organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Response

json
Success. Returns the requested resource.
audit: object
masterOrganizationId: string
organizationId: string
id: number
status: string
approvedDate: string
rejectedDate:
revokedDate:
applicationId: number
application: object
tierId: number
tier: object
requestedTierId:
requestedTier:
terms:
groupInstanceId:
groupInstance:
partyId: string
partyName: string
condition: string
managedServiceApi: object
managedServiceApiId: number
Examples
Contract
{ "value": { "audit": { "created": { "date": "2020-11-02T18:29:11.233Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 135, "status": "APPROVED", "approvedDate": "2020-11-02T18:29:11.285Z", "rejectedDate": null, "revokedDate": null, "applicationId": 8, "application": { "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 8, "name": "Client APP 1603822451", "description": "This is the description", "clientProvider": { "providerId": null }, "coreServicesId": "eea7e89a970f46818827c425918e6979", "url": "http://www.salesforce-app.com", "grantTypes": [], "redirectUri": [], "clientId": "eea7e89a970f46818827c425918e6979", "owner": "Organization Owner", "email": "api.platform.qa+o_o@gmail.com", "owners": [ { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "username": "organization_owner" } ] }, "tierId": 307, "tier": { "audit": { "created": { "date": "2020-10-26T15:36:20.600Z" }, "updated": { "date": "2020-10-27T15:38:02.573Z" } }, "id": 307, "name": "tier-1603813082", "description": "tier description", "limits": [ { "visible": true, "maximumRequests": 40, "timePeriodInMilliseconds": 1 } ], "status": "ACTIVE", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "groupInstanceId": null, "groupInstance": null, "partyId": "", "partyName": "", "condition": "APPLIED", "managedServiceApi": { "audit": { "created": {}, "updated": {} }, "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 193 }, "managedServiceApiId": 193 } }

Edit a managed service API contract updateManagedServiceApiContract

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Edit a contract of a Managed Service API

Path Parameters

contractId *: string
organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Request Body *

json
status: string
tierId: integer
Examples
Contract
{ "value": { "tierId": 307, "status": "APPROVED" } }

Response

json
Created. The resource was successfully created.
audit: object
masterOrganizationId: string
organizationId: string
id: number
status: string
approvedDate: string
rejectedDate:
revokedDate:
applicationId: number
application: object
tierId: number
tier: object
requestedTierId:
requestedTier:
terms:
groupInstanceId:
groupInstance:
partyId: string
partyName: string
condition: string
managedServiceApi: object
managedServiceApiId: number
Examples
Contract
{ "value": { "audit": { "created": { "date": "2020-10-28T19:44:29.541Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 130, "status": "APPROVED", "approvedDate": "2020-10-28T19:44:29.576Z", "rejectedDate": null, "revokedDate": null, "applicationId": 8, "application": { "audit": { "created": { "date": "2020-10-27T18:14:12.397Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "id": 8, "name": "Client APP 1603822451", "description": "This is the description", "clientProvider": { "providerId": null }, "coreServicesId": "eea7e89a970f46818827c425918e6979", "url": "http://www.salesforce-app.com", "grantTypes": [], "redirectUri": [], "clientId": "eea7e89a970f46818827c425918e6979", "clientSecret": "24e4fdb4E0434a089470fa4487c7Ed2b", "owner": "Organization Owner", "email": "api.platform.qa+o_o@gmail.com", "owners": [ { "id": "57e281b5-ec5b-4701-80a0-92a936a68da3", "createdAt": "2020-05-27T19:27:14.150Z", "updatedAt": "2020-10-28T19:40:18.311Z", "organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "firstName": "Organization", "lastName": "Owner", "email": "api.platform.qa+o_o@gmail.com", "phoneNumber": "111-111-1111", "idprovider_id": "mulesoft", "username": "organization_owner", "enabled": true, "deleted": false, "lastLogin": "2020-10-28T22:40:00.000Z", "roles": [ "cc43e20e-c04b-4c86-a29e-49ac7e7f8b58" ], "type": "host" } ] }, "tierId": 307, "tier": { "audit": { "created": { "date": "2020-10-26T15:36:20.600Z" }, "updated": { "date": "2020-10-27T15:38:02.573Z" } }, "id": 307, "name": "tier-1603813082", "description": "tier description", "limits": [ { "visible": true, "maximumRequests": 40, "timePeriodInMilliseconds": 1 } ], "status": "ACTIVE", "autoApprove": true }, "requestedTierId": null, "requestedTier": null, "terms": null, "groupInstanceId": null, "groupInstance": null, "partyId": "", "partyName": "", "condition": "APPLIED", "managedServiceApi": { "audit": { "created": { "date": "2020-10-16T18:32:19.562Z" }, "updated": {} }, "masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043", "organizationId": "4b1240fd-e1df-44a8-9949-6778c3d3dd91", "id": 193, "portalId": null, "description": null, "providerId": null, "rootFileId": null, "deprecated": false, "lastActiveDate": null, "endpointUri": "http://graph.hsbc.com/api", "environmentId": "b1bf299f-0590-4e00-83c6-b78bb3dc92ff", "isPublic": false, "termsDate": null, "endpoint": { "uri": "http://mygraph.cloudhub.io/api" }, "deployment": null, "permissions": { "update": true } }, "managedServiceApiId": 193 } }

Delete a managed service API contract deleteManagedServiceApiContract

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete a contract of a Managed Service API

Path Parameters

contractId *: string
organizationId *: string
environmentId *: string
managedServiceApiId *: integer

Response

No Content. The operation completed successfully with no response body.

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

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

Response

Success. Returns the requested resource.
Examples
application/json
{ "total": 0, "data": [] }

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
definition: string(binary)
Policy template definition file in YAML with the implementation and execution logic.
configuration: string(binary)
Policy configuration schema file in YAML/JSON defining the configurable parameters.
name: string
Unique name identifying the custom policy template.
gatewayVersion: string
Target Mule Gateway version (e.g., 4.x, 3.x) determining compatibility.

Response

The new element has been successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

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

customPolicyTemplateId *: integer
organizationId *: string

Response

Success. Returns the requested resource.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "name": "Example Resource" }

Replace 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

customPolicyTemplateId *: integer
organizationId *: string

Request Body *

json
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

Created. The resource was successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Update 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

customPolicyTemplateId *: integer
organizationId *: string

Request Body *

json
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

Success. Returns the requested resource.
Examples
application/json
{ "message": "Resource updated successfully" }

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

customPolicyTemplateId *: integer
organizationId *: string

Response

The element has been deleted successfully.

Get custom policy template configuration getCustomPolicyTemplateConfiguration

GET

Try it out

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

Path Parameters

customPolicyTemplateId *: integer
organizationId *: string

Response

Success. Returns the requested resource.
Examples
application/json
{ "total": 0, "data": [] }

Get custom policy template definition getCustomPolicyTemplateDefinition

GET

Try it out

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

Path Parameters

customPolicyTemplateId *: integer
organizationId *: string

Response

Success. Returns the requested resource.
Examples
application/json
{ "total": 0, "data": [] }

List policy templates listPolicyTemplates

GET

Try it out

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

Connected Apps require the following scopes:
- View Policies

Path Parameters

organizationId *: string

Query Parameters

apiInstanceId: integer
version: string

Response

Successful.
Examples
application/json
{ "total": 0, "data": [] }

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.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "name": "Example Resource" }

List automated policies listAutomatedPolicies

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Searches for a list of Automated Policies that apply to a certain scope

Connected Apps require the following scopes:
- View Policies

Path Parameters

organizationId *: string

Query Parameters

environmentId *: string
runtimeVersion: string
A semver string that will be checked for an exact match of Runtime Version

Response

json
Successful
automatedPolicies: array
total: number
Examples
AutomatedPolicies
{ "value": { "automatedPolicies": [ { "audit": { "created": { "date": "2018-11-23T14:37:08.953Z" }, "updated": {} }, "id": 11, "ruleOfApplication": { "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "environmentId": "5d15a77c-0d35-400e-9a90-61d0beb09409", "range": { "from": "4.1.1", "to": "4.3.x" } }, "policyTemplateId": "2", "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "assetId": "rate-limiting", "assetVersion": "1.0.0", "configurationData": { "rateLimits": [ { "timePeriodInMilliseconds": 60000, "maximumRequests": 3 } ], "clusterizable": true, "exposeHeaders": true }, "pointcutData": null, "order": null, "disabled": false } ], "total": 1 } }

Create an automated policy createAutomatedPolicy

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an Automated Policy

Connected Apps require the following scopes:
- Manage Policies

Path Parameters

organizationId *: string

Request Body *

json
ruleOfApplication *: object
groupId *: string
assetId *: string
assetVersion *: string
configurationData *: object | array
order: integer
disabled: boolean
Examples
AutomatedPolicy
{ "value": { "ruleOfApplication": { "environmentId": "5d15a77c-0d35-400e-9a90-61d0beb09409", "range": { "from": "4.1.1", "to": "4.3.x" } }, "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "assetId": "rate-limiting", "assetVersion": "1.0.0", "configurationData": { "rateLimits": [ { "timePeriodInMilliseconds": 60000, "maximumRequests": 3 } ], "clusterizable": true, "exposeHeaders": true } } }

Response

Automated Policy was created successfully
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Count automated policies checkAutomatedPolicies

HEAD

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets count of Automated Policies that apply to a certain scope

Connected Apps require the following scopes:
- View Policies

Path Parameters

organizationId *: string

Query Parameters

environmentId *: string
runtimeVersion: string
A semver string that will be checked for an exact match of Runtime Version

Response

Successful

Get an automated policy getAutomatedPolicy

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves an Automated Policy.

Connected Apps require the following scopes:
- View Policies

Path Parameters

organizationId *: string
automatedPolicyId *: integer

Response

json
Successful
audit: object
id: number
ruleOfApplication: object
policyTemplateId: string
groupId: string
assetId: string
assetVersion: string
configurationData: object
pointcutData:
order:
disabled: boolean
Examples
AutomatedPolicies
{ "value": { "audit": { "created": { "date": "2018-11-23T14:37:08.953Z" }, "updated": {} }, "id": 11, "ruleOfApplication": { "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "environmentId": "5d15a77c-0d35-400e-9a90-61d0beb09409", "range": { "from": "4.1.1", "to": "4.3.x" } }, "policyTemplateId": "2", "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "assetId": "rate-limiting", "assetVersion": "1.0.0", "configurationData": { "rateLimits": [ { "timePeriodInMilliseconds": 60000, "maximumRequests": 3 } ], "clusterizable": true, "exposeHeaders": true }, "pointcutData": null, "order": null, "disabled": false } }

Replace an automated policy updateAutomatedPolicy

PUT

Try it out

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

Path Parameters

organizationId *: string
automatedPolicyId *: integer

Request Body *

json
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

Created. The resource was successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Update an automated policy patchAutomatedPolicy

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates an Automated Policy

Connected Apps require the following scopes:
- Manage Policies

Path Parameters

organizationId *: string
automatedPolicyId *: integer

Request Body *

json
ruleOfApplication *: object
groupId *: string
assetId *: string
assetVersion *: string
configurationData *: object | array
order: integer | null
disabled: boolean
Examples
AutomatedPolicy
{ "value": { "ruleOfApplication": { "environmentId": "5d15a77c-0d35-400e-9a90-61d0beb09409", "range": { "from": "4.1.1", "to": "4.3.x" } }, "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913", "assetId": "rate-limiting", "assetVersion": "1.0.0", "configurationData": { "rateLimits": [ { "timePeriodInMilliseconds": 60000, "maximumRequests": 3 } ], "clusterizable": true, "exposeHeaders": true } } }

Response

Automated Policy successfully updated
Examples
application/json
{ "message": "Resource updated successfully" }

Delete an automated policy deleteAutomatedPolicy

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes an Automated Policy

Connected Apps require the following scopes:
- Manage Policies

Path Parameters

organizationId *: string
automatedPolicyId *: integer

Response

Automated Policy successfully deleted

List APIs affected by policy listAutomatedPolicyApis

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets deployed APIs affected by Automated Policy

Connected Apps require the following scopes:
- View Policies

Path Parameters

organizationId *: string
automatedPolicyId *: integer

Query Parameters

type: string
deployedOnly: any
runtimes: string
offset: integer
limit: integer

Response

json
Success. Returns the requested resource.
total: number
apis: array
Examples
AutomatedPolicies
{ "value": { "total": 1, "apis": [ { "id": 15, "isPublic": false, "groupId": "c44be829-3d89-4b70-80be-277b7633bc5a", "assetId": "ultimate-open-weather", "assetVersion": "1.0.4", "productVersion": "1.0", "environmentId": "fc3322cf-1e42-4b86-a11b-d6a3550af30e", "endpointUri": null, "instanceName": "external", "instanceLabel": "external" } ] } }

Remove incompatible API from policy deleteAutomatedPolicyIncompatibleApi

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Delete Automated Policy coverage over the apiVersion specified due to incompatible implementation for the proxy version.

Path Parameters

environmentApiId *: integer
organizationId *: string
automatedPolicyId *: integer

Query Parameters

environmentId *: string

Response

API left uncovered from Automated Policy

Update policy implementation assets setAutomatedPolicyImplementationAssets

POST

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Updates implementation assets

Connected Apps require the following scopes:
- Manage Policies

Path Parameters

organizationId *: string
automatedPolicyId *: integer

Query Parameters

dryRun: any

Response

Implementation asset successfully deployed
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

List groups listGroups

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves all groups within an organization

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string

Query Parameters

name: string
Search groups by name

Response

json
Successful
total: number
groups: array
Examples
Groups
{ "value": { "total": 4, "groups": [ { "id": 4, "name": "Social Media", "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "assetGroupId": "", "assetId": "", "versions": [ { "id": 49, "groupId": 4, "name": "v1", "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "isPublic": true, "assetVersion": "", "productVersion": "", "instances": [ { "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} }, "id": 1072, "groupId": 4, "groupVersionId": 49, "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "environmentId": "22126179-3dae-43f5-ac23-cbc9ecc29c53", "assetGroupId": null, "assetId": null, "assetVersion": null, "productVersion": null, "groupInstanceLabel": null, "status": "DRAFT", "deprecated": false, "apiInstances": [ { "id": 312440, "groupInstanceId": 1072 } ] } ], "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} } } ], "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} } } ] } }

Create a group createGroup

POST

Try it out

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

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

organizationId *: string

Request Body *

json
name *: string
versions *: array
Examples
Group
{ "value": { "name": "Social Media", "versions": [ { "name": "v1", "instances": [ { "apiInstances": [ 1, 45 ], "environmentId": "5ead2051-f855-425a-9226-312c562ed268" } ] } ] } }

Response

json
Group was created successfully
id: number
name: string
masterOrganizationId: string
organizationId: string
versions: array
audit: object
Examples
Groups
{ "value": { "id": 4, "name": "Social Media", "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "versions": [ { "id": 49, "groupId": 4, "name": "v1", "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "createdDate": "2019-03-21T18:40:23.955Z", "instances": [ { "id": 1074, "groupId": 4, "groupVersionId": 49, "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "apiInstances": [ 1, 45 ], "environmentId": "5ead2051-f855-425a-9226-312c562ed268", "createdDate": "2019-03-21T18:40:23.955Z", "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} } } ], "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} } } ], "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} } } }

Get a group getGroup

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a Group

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

groupId *: integer
organizationId *: string

Response

json
Successful
id: number
name: string
masterOrganizationId: string
organizationId: string
assetGroupId: string
assetId: string
versions: array
audit: object
Examples
Group
{ "value": { "id": 4, "name": "Social Media", "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "assetGroupId": "", "assetId": "", "versions": [ { "id": 49, "groupId": 4, "name": "v1", "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "assetVersion": "", "productVersion": "", "instances": [ { "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} }, "id": 1072, "groupId": 4, "groupVersionId": 49, "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "environmentId": "22126179-3dae-43f5-ac23-cbc9ecc29c53", "assetGroupId": null, "assetId": null, "assetVersion": null, "productVersion": null, "groupInstanceLabel": null, "status": "DRAFT", "deprecated": false, "apiInstances": [ { "id": 312440, "groupInstanceId": 1072 } ] } ], "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} } } ], "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} } } }

Replace a group updateGroup

PUT

Try it out

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

Path Parameters

groupId *: integer
organizationId *: string

Request Body *

json
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

Created. The resource was successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Update a group patchGroup

PATCH

Try it out

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

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

groupId *: integer
organizationId *: string

Request Body *

json
name *: string
Examples
Group
{ "value": { "name": "New Name" } }

Response

Group successfully updated
Examples
application/json
{ "message": "Resource updated successfully" }

Delete a group deleteGroup

DELETE

Try it out

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

Path Parameters

groupId *: integer
organizationId *: string

Response

The element has been deleted successfully.

Create a group asset createGroupAsset

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a group asset

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

groupId *: integer
organizationId *: string

Request Body *

json
name: string
version *: string
versionId *: integer
Examples
application/json
{ "name": "Example Resource", "description": "Example description" }

Response

Group asset successfully created
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

List group versions listGroupVersions

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves all versions of a Group

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

groupId *: integer
organizationId *: string

Response

json
Successful
total: number
versions: array
Examples
Group
{ "value": { "total": 1, "versions": [ { "id": 49, "groupId": 4, "name": "v1", "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "assetVersion": "", "productVersion": "", "instances": [ { "audit": { "created": { "date": "2020-04-17T16:57:44.218Z" }, "updated": {} }, "id": 1072, "groupId": 1066, "groupVersionId": 49, "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "environmentId": "22126179-3dae-43f5-ac23-cbc9ecc29c53", "assetGroupId": null, "assetId": null, "assetVersion": null, "productVersion": null, "groupInstanceLabel": null, "status": "DRAFT", "deprecated": false, "apiInstances": [ { "id": 312440, "groupInstanceId": 1072 } ] } ], "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} } } ] } }

Create a group version createGroupVersion

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a Group Version

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

groupId *: integer
organizationId *: string

Request Body *

json
name *: string
instances *: array
Examples
Group
{ "value": { "name": "v2", "instances": [ { "apiInstances": [ 14 ], "environmentId": "5ead2051-f855-425a-9226-312c562ed268", "deprecated": false } ] } }

Response

json
Group was created successfully
id: number
groupId: number
name: string
masterOrganizationId: string
organizationId: string
createdDate: string
instances: array
audit: object
Examples
Group
{ "value": { "id": 50, "groupId": 4, "name": "v2", "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "createdDate": "2020-04-17T17:43:42.293Z", "instances": [ { "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} }, "id": 1072, "groupId": 4, "groupVersionId": 49, "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "environmentId": "22126179-3dae-43f5-ac23-cbc9ecc29c53", "apiInstances": [ 1, 67 ] } ], "audit": { "created": { "date": "2019-03-21T20:40:23.955Z" }, "updated": {} } } }

Get a group version getGroupVersion

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a Group Version

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

groupId *: integer
organizationId *: string
groupVersionId *: integer

Response

json
Successful
id: number
groupId: number
name: string
masterOrganizationId: string
organizationId: string
assetVersion: string
productVersion: string
instances: array
audit: object
Examples
Group
{ "value": { "id": 49, "groupId": 4, "name": "v1", "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "assetVersion": "", "productVersion": "", "instances": [ { "audit": { "created": { "date": "2020-04-17T16:57:44.218Z" }, "updated": {} }, "id": 1072, "groupId": 1066, "groupVersionId": 49, "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "environmentId": "22126179-3dae-43f5-ac23-cbc9ecc29c53", "assetGroupId": null, "assetId": null, "assetVersion": null, "productVersion": null, "groupInstanceLabel": null, "status": "DRAFT", "deprecated": false, "apiInstances": [ { "id": 312440, "groupInstanceId": 1072 } ] } ], "audit": { "created": { "date": "2019-03-21T18:40:23.955Z" }, "updated": {} } } }

Replace a group version updateGroupVersion

PUT

Try it out

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

Path Parameters

groupId *: integer
organizationId *: string
groupVersionId *: integer

Request Body *

json
Examples
application/json
{ "name": "Updated Resource", "description": "Updated description" }

Response

Created. The resource was successfully created.
Examples
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "message": "Resource created successfully" }

Update a group version patchGroupVersion

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a Group Version

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

groupId *: integer
organizationId *: string
groupVersionId *: integer

Request Body *

json
name: string
Examples
Group
{ "value": { "name": "v3" } }

Response

Group Version successfully updated
Examples
application/json
{ "message": "Resource updated successfully" }

Delete a group version deleteGroupVersion

DELETE

Try it out

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

Path Parameters

groupId *: integer
organizationId *: string
groupVersionId *: integer

Response

The element has been deleted successfully.

List group version instances listGroupVersionInstances

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the instances contained in a Group Version

Connected Apps require the following scopes:
- API Group Administrator

Path Parameters

groupId *: integer
organizationId *: string
groupVersionId *: integer

Response

json
Successful
total: number
instances: array
Examples
Groups
{ "value": { "total": 2, "instances": [ { "id": 1, "groupId": 1066, "groupVersionId": 1073, "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "environmentId": "f81fb343-3649-4990-832e-27de26ee649e", "exchangeAssetName": "Facebook API", "instanceLabel": null, "assetGroupId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "assetId": "facebook-api", "assetVersion": "1.0.0", "productVersion": "v1", "groupInstanceLabel": null, "status": "DRAFT", "deprecated": false, "groupName": "test", "groupVersionName": "v1", "apiInstances": [ { "id": 312440, "groupInstanceId": 1072 } ] }, { "id": 45, "groupId": 1066, "groupVersionId": 1073, "masterOrganizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "environmentId": "5d15a77c-0d35-400e-9a90-61d0beb09409", "exchangeAssetName": "Instagram API", "instanceLabel": null, "assetGroupId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a", "assetId": "instagram-api", "assetVersion": "1.0.1", "productVersion": "v1", "groupInstanceLabel": null, "status": "DRAFT", "deprecated": false, "groupName": "test", "groupVersionName": "v1", "apiInstances": [ { "id": 312440, "groupInstanceId": 1072 } ] } ] } }