Overview
Statistics
170
Operations
0
Skills
API Management
Category
Manage APIs, applications, alerts, and classifications in the Anypoint API Platform repository.
Servers
-
https://anypoint.mulesoft.com/apiplatform/repository/{version} -
https://{region}.anypoint.mulesoft.com/apiplatform/repository/{version} -
https://{region}.platform.mulesoft.com/apiplatform/repository/{version}
Authentication & Security
-
bearerAuth http
Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login
-
clientAuth oauth2
OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token
Get Public Apis getPublicApis
GET
Try it out
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of APIs.
Query Parameters
requireRaml *:
booleanSearch only those APIs which have a publicly accesible RAML specification.
offset *:
integerSkip over a number of elements by specifying an offset value for the query.
default:
0, min: 0, max: 2147483647limit *:
integerLimit the number of elements on the response.
default:
100, min: 1, max: 250sort *:
stringProperty to sort by.
ascending *:
booleanOrder for sorting.
query *:
stringSearch criteria.
Response
Successful operation.
Get Organizations Active getOrganizationsActive
GET
Try it out
Custom Query Parameters
Custom Headers
Get the active organization.
Response
Successful operation.
Get Organizations By Organizationid getOrganizationsByOrganizationid
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get the organization.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
extended *:
booleanObtain extended information from the organization.
resolveTheme *:
booleanResolves the theme inheritance.
Response
Successful.
Update Organizations By Organizationid updateOrganizationsByOrganizationid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update the organization.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
jsonResponse
Successful.
Delete Organizations By Organizationid deleteOrganizationsByOrganizationid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Delete the organization.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Organization deleted.
Get Organizations By Organizationid Migration Mapping getOrganizationsByOrganizationidMigrationMapping
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Get all api version migration mappings in CSV format. This is for setting up the Crowd upgrade.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Permissions getOrganizationsByOrganizationidPermissions
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Alerts getOrganizationsByOrganizationidAlerts
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets a collection of alerts.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
apiVersionId *:
stringThe apiVersion ID query parameter.
tierId *:
stringThe tier ID query parameter.
lastModifiedSince *:
integerReturn items which have been modified since the specified timestamp
min: 0
alertId *:
stringThe alert ID query parameter.
query *:
stringSearch criteria.
policyId *:
stringThe policy ID query parameter.
offset *:
integerSkip over a number of elements by specifying an offset value for the query.
default:
0, min: 0, max: 2147483647apiId *:
stringThe api ID query parameter.
ascending *:
booleanOrder for sorting.
environmentId *:
stringThe environment ID query parameter.
Related Operations:
severity *:
stringThe severity query parameter.
sort *:
stringProperty to sort by.
type *:
stringThe type query parameter.
limit *:
integerLimit the number of elements on the response.
default:
100, min: 1, max: 250active *:
booleanThe active query parameter.
Response
Successfully retrieved alert definitions.
Examples
application/json
{
"total": 1234,
"data": [
{
"apiVersion": {
"name": "My First API",
"id": 12345,
"apiId": 67890
},
"name": "My First API's Request Count Alert",
"severity": "warning",
"recipients": [
{
"role": "Api Version Owner"
},
{
"userId": "abcde-fghij-klmno",
"name": "Jane Doe",
"email": "jane.doe@example.com"
}
],
"period": {
"duration": {
"count": 1,
"weight": "HOURS"
},
"repeat": 4
},
"type": "requestCount",
"condition": {
"aggregate": "count",
"operator": "GREATER_THAN",
"value": 1000
}
},
{
"apiVersion": {
"name": "My First API",
"id": 12345,
"apiId": 67890
},
"name": "My First API's Request Count Alert",
"severity": "warning",
"recipients": [
{
"role": "Api Version Owner"
},
{
"userId": "abcde-fghij-klmno",
"name": "Jane Doe",
"email": "jane.doe@example.com"
}
],
"period": {
"duration": {
"count": 1,
"weight": "HOURS"
},
"repeat": 4
},
"type": "requestCount",
"condition": {
"aggregate": "count",
"operator": "GREATER_THAN",
"value": 1000
}
}
]
}
Create Organizations By Organizationid Alerts createOrganizationsByOrganizationidAlerts
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
jsonResponse
The new element has been successfully created.
Get Organizations By Organizationid Environments getOrganizationsByOrganizationidEnvironments
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
withCloudhubPermissions *:
booleanAdd to each environment the user's permissions in CloudHub
default:
Trueall *:
booleanRetrieve all environments, without filtering by the user's permissions.
default:
FalseResponse
Successful operation.
Get Organizations By Organizationid Environments Default getOrganizationsByOrganizationidEnvironmentsDefault
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a default.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Examples
application/json
{
"id": "80139f69-2845-46fa-9217-d9fe0171030f",
"name": "QA",
"organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043",
"isProduction": false
}
Get Organizations By Organizationid Environments By Environmentid Apis By Apiid Versions By Apiversionid Alerts getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlerts
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
apiId *:
stringThe api ID to identify the target resource.
apiVersionId *:
stringThe apiVersion ID to identify the target resource.
Response
Successfully retrieved an API Version's alert definitions.
Create Organizations By Organizationid Environments By Environmentid Apis By Apiid Versions By Apiversionid Alerts createOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlerts
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
apiId *:
stringThe api ID to identify the target resource.
apiVersionId *:
stringThe apiVersion ID to identify the target resource.
Request Body
jsonapiAlertsVersion *:
anyname *:
stringminLength: 1, maxLength: 255
api *:
objectapiVersion *:
objectenabled *:
booleanseverity *:
anyrecipients *:
arrayperiod *:
objectcondition *:
objectResponse
Successfully created alert definition.
Get Organizations By Organizationid Environments By Environmentid Apis By Apiid Versions By Apiversionid Alerts By Alertid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlertsByAlertid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets an alert.
Path Parameters
apiVersionId *:
stringThe apiVersion ID to identify the target resource.
alertId *:
stringThe alert ID to identify the target resource.
apiId *:
stringThe api ID to identify the target resource.
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successfully retrieved alert definition.
apiAlertsVersion *:
anyname *:
stringminLength: 1, maxLength: 255
api *:
objectapiVersion *:
objectenabled *:
booleanseverity *:
anyrecipients *:
arrayperiod *:
objectcondition *:
objectExamples
application/json
{}
Patch Organizations By Organizationid Environments By Environmentid Apis By Apiid Versions By Apiversionid Alerts By Alertid patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlertsByAlertid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a alert.
Path Parameters
apiVersionId *:
stringThe apiVersion ID to identify the target resource.
alertId *:
stringThe alert ID to identify the target resource.
apiId *:
stringThe api ID to identify the target resource.
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
jsonapiAlertsVersion:
anyname:
stringenabled:
booleanseverity:
anyrecipients:
arrayperiod:
objectcondition:
objectResponse
Successfully updated alert definition.
Examples
application/json
{
"type": "api-request-count",
"apiAlertsVersion": "1.0.0",
"api": {
"name": "My First API",
"id": 22
},
"apiVersion": {
"name": "First version",
"id": 77
},
"enabled": true,
"resources": [
"foo-api-version-id"
],
"name": "My First API's Request Count Alert",
"severity": "WARNING",
"recipients": [
{
"type": "role",
"value": "API_VERSION_OWNER"
},
{
"type": "user",
"value": "foo-user-id"
},
{
"type": "email",
"value": "foo_email@example.com"
}
],
"period": {
"duration": {
"count": 1,
"weight": "HOURS"
},
"repeat": 4
},
"condition": {
"resourceType": "api-version",
"aggregate": "COUNT",
"operator": "GREATER_THAN",
"value": 1000,
"filter": [
{
"property": "apiVersionId",
"operator": "EQUAL",
"values": [
"foo-api-version-id"
]
}
]
}
}
Delete Organizations By Organizationid Environments By Environmentid Apis By Apiid Versions By Apiversionid Alerts By Alertid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByApiidVersionsByApiversionidAlertsByAlertid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the specified alert definition.
Path Parameters
apiVersionId *:
stringThe apiVersion ID to identify the target resource.
alertId *:
stringThe alert ID to identify the target resource.
apiId *:
stringThe api ID to identify the target resource.
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successfully deleted alert definition.
Update Organizations By Organizationid Theme updateOrganizationsByOrganizationidTheme
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Update the organization theme.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
multipart/form-dataResponse
Successful operation.
Get Organizations By Organizationid Theme Default getOrganizationsByOrganizationidThemeDefault
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Get the default theme for an organization.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Portals Terms getOrganizationsByOrganizationidPortalsTerms
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets portal terms set for the organization.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Update Organizations By Organizationid Portals Terms updateOrganizationsByOrganizationidPortalsTerms
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create portal terms for the organization.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Portals Terms deleteOrganizationsByOrganizationidPortalsTerms
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes portal terms for the organization.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Operation completed successfully with no content returned.
Update Organizations By Organizationid Portals Redirecturi updateOrganizationsByOrganizationidPortalsRedirecturi
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update redirect uri of the list of portals for the organization
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
jsonResponse
Successful operation.
Get Organizations By Organizationid Apis getOrganizationsByOrganizationidApis
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of APIs.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
query *:
stringSearch criteria.
offset *:
integerSkip over a number of elements by specifying an offset value for the query.
default:
0, min: 0, max: 2147483647filters *:
stringThe filters query parameter.
ascending *:
booleanOrder for sorting.
requirePortal *:
booleanThe requirePortal query parameter.
sort *:
stringProperty to sort by.
limit *:
integerLimit the number of elements on the response.
default:
100, min: 1, max: 250Response
Successful operation.
Create Organizations By Organizationid Apis createOrganizationsByOrganizationidApis
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an API.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
jsonResponse
The new element has been successfully created.
Get Organizations By Organizationid Apis By Name getOrganizationsByOrganizationidApisByName
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a single API that matches the passed-in API name.
Returns null if no match is found.
Returns null if no match is found.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
apiName *:
stringThe apiName query parameter.
Response
Successful operation.
Create Organizations By Organizationid Apis Versions createOrganizationsByOrganizationidApisVersions
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create an API Version from an Exchange Spec. Only available after the Crowd upgrade.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
jsonspec *:
objectname *:
stringminLength: 1, maxLength: 150
Response
Resource created successfully.
Examples
application/json
{
"apiId": 26,
"assetVersion": "1.0.0",
"productVersion": "v1",
"environmentId": null,
"name": "unclassified api version from GAV",
"order": 1,
"audit": {
"created": {
"date": "2017-09-19T21:27:47.177000+00:00"
},
"updated": {}
},
"masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043",
"organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043",
"id": 97,
"groupId": "f0c9b011-980e-4928-9430-e60e3a97c043",
"assetId": "api-test",
"tags": [],
"terms": null
}
Get Organizations By Organizationid Apis Versions By Endpoint getOrganizationsByOrganizationidApisVersionsByEndpoint
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of API versions for a given list of endpoints.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
uris *:
arrayThe uris query parameter.
Response
Successful operation.
Get Organizations By Organizationid Apis Versions By Name getOrganizationsByOrganizationidApisVersionsByName
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a single API that matches the passed-in API name
and API version name. Returns null if no match is found.
and API version name. Returns null if no match is found.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
apiName *:
stringThe apiName query parameter.
versionName *:
stringThe versionName query parameter.
Response
Successful operation.
Get Organizations By Organizationid Apis Versions Tiers getOrganizationsByOrganizationidApisVersionsTiers
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns permitted SLA tiers within an organization.
It means every SLA tier that belongs to API version requesting user has access to.
It means every SLA tier that belongs to API version requesting user has access to.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Apis Versions Contracts Applications getOrganizationsByOrganizationidApisVersionsContractsApplications
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns permitted applications within an organization.
It means every applications that has a contract with an API version requesting user has access to.
It means every applications that has a contract with an API version requesting user has access to.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Apis By Apiid getOrganizationsByOrganizationidApisByApiid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns an API and all its versions.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Response
Successful operation.
Patch Organizations By Organizationid Apis By Apiid patchOrganizationsByOrganizationidApisByApiid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a apis.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Apis By Apiid deleteOrganizationsByOrganizationidApisByApiid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes a apis.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Response
Operation completed successfully with no content returned.
Get Organizations By Organizationid Apis By Apiid Portals getOrganizationsByOrganizationidApisByApiidPortals
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns a collection of API portals.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Response
Successful operation.
Create Organizations By Organizationid Apis By Apiid Permissions createOrganizationsByOrganizationidApisByApiidPermissions
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Grant a user view access to this API.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Request Body
jsonResponse
The new element has been successfully created.
Create Organizations By Organizationid Apis By Apiid Versions createOrganizationsByOrganizationidApisByApiidVersions
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Request Body
jsonResponse
The new element has been successfully created.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid getOrganizationsByOrganizationidApisByApiidVersionsByApiversionid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Update Organizations By Organizationid Apis By Apiid Versions By Apiversionid updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Patch Organizations By Organizationid Apis By Apiid Versions By Apiversionid patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
The element has been deleted successfully.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Classify createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidClassify
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
(Only avaliable after the Crowd upgrade) Moves an API Version from the unclassified environment into a specified environment.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsoninstanceLabel:
anyenvironmentId *:
stringminLength: 1, maxLength: 255
Response
Resource created successfully.
Examples
application/json
{
"audit": {
"created": {
"date": "2017-09-01T18:34:50.783000+00:00"
},
"updated": {
"date": "2017-09-11T14:49:53.257000+00:00"
}
},
"masterOrganizationId": "f0c9b011-980e-4928-9430-e60e3a97c043",
"organizationId": "f0c9b011-980e-4928-9430-e60e3a97c043",
"id": 25,
"apiId": 5,
"portalId": 11,
"name": "dolorem 25",
"instanceLabel": "my-instance-label",
"groupId": "f0c9b011-980e-4928-9430-e60e3a97c043",
"assetId": "api-test",
"assetVersion": "1.0.0",
"productVersion": "v1",
"description": "accusamus dolorem et rerum placeat libero doloremque id quia vitae illo et suscipit sed nam ipsa qui in eum reiciendis incidunt corporis est iusto voluptas magnam pariatur adipisci fugiat voluptatibus odio aut sed culpa dignissimos sit quis quo est corrupti omnis quaerat voluptatum enim asperiores voluptatem exercitationem et accusantium illum",
"tags": [
"accusantium",
"voluptatem",
"dolores",
"hic",
"nostrum",
"quia",
"aut",
"alias",
"in",
"qui"
],
"order": 5,
"rootFileId": 23,
"deprecated": false,
"lastActiveDate": null,
"endpointUri": null,
"environmentId": "2ba4f3f8-0d26-49f6-8fd5-ea508abbb7ea",
"isPublic": false,
"terms": null,
"termsDate": "2017-09-08T19:41:01.096000+00:00"
}
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Export getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidExport
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Exports an API Version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
portal *:
booleanInclude portal.
files *:
booleanInclude definition files.
slaTiers *:
booleanInclude SLA tiers.
portalAttachments *:
booleanInclude portal attachments.
endpoint *:
booleanInclude endpoint definition.
portalFiles *:
booleanInclude portal images.
Response
Successful operation.
Examples
application/zip
{
"message": "Operation completed successfully."
}
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Users getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidUsers
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Search for users.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
search *:
stringSearch or filter expression to narrow results.
includeCurrent *:
booleanWhether to include the currently logged-in user in the search results or not.
offset *:
integerOffset on the amount of assets (each of which has all its apis)
default:
0limit *:
integerLimit on the amount of assets (each of which has all its apis)
default:
25Response
Successful operation.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Users By Roles getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidUsersByRoles
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Search for users who match a specific set of roles.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
API_VERSION_OWNER *:
stringContext params for the API VERSION OWNER role.
PORTAL_ACCESS *:
stringContext params for the PORTAL ACCESS role.
Response
Successful operation.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Users Owners getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidUsersOwners
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Return all owners of an API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Permissions createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPermissions
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Grant a user admin access to this API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Resource created successfully.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Permissions deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPermissions
DELETE
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Revoke a user's admin access to this API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
userId *:
stringThe user ID query parameter.
Response
Operation completed successfully with no content returned.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Migration Mapping getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidMigrationMapping
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get the api version migration mapping of an API version
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
apiVersionId *:
stringThe apiVersion ID query parameter.
Response
Successful operation.
Examples
application/json
{
"masterOrganizationId": "9881ab9d-e73a-47cd-8105-d0b5f1a27fa1",
"organizationId": "9881ab9d-e73a-47cd-8105-d0b5f1a27fa1",
"id": 4399,
"apiVersionId": 116409,
"apiName": "newName",
"apiVersionName": "newVersion",
"migratePortal": true,
"crowdOneAccount": false
}
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Migration Mapping createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidMigrationMapping
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a migration mapping for an API version
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Resource created successfully.
Update Organizations By Organizationid Apis By Apiid Versions By Apiversionid Migration Mapping updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidMigrationMapping
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update a migration mapping of an API version
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortal
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Obtain the portal associated with the API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
resolveTheme *:
booleanResolves theme inheritance.
Response
Successful operation.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortal
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a portal and associates it with an API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Resource created successfully.
Patch Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortal
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a portal and associates it with an API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Permissions createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPermissions
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Grant a user view access to this portal.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Resource created successfully.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Permissions deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPermissions
DELETE
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Revoke a user's view access to portal.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
userId *:
stringThe user ID query parameter.
Response
Operation completed successfully with no content returned.
Update Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Redirecturi updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalRedirecturi
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update redirec uri for a portal
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Pages createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPages
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
The new element has been successfully created.
Update Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Pages By Pageid updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPagesByPageid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update an existing page.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
pageId *:
integerThe page ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Pages By Pageid deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPagesByPageid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes a pages.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
pageId *:
integerThe page ID to identify the target resource.
min: 1, max: 2147483647
Response
Operation completed successfully with no content returned.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Pages By Pageid Widgets getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPagesByPageidWidgets
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns all content widgets of a page.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
pageId *:
integerThe page ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Patch Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Pages By Pageid Widgets patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalPagesByPageidWidgets
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the collection of widgets.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
pageId *:
integerThe page ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Update Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Theme updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalTheme
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Update the portal theme.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
multipart/form-dataResponse
Successful operation.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Files createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalFiles
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Upload an api portal file.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
multipart/form-dataResponse
The new element has been successfully created.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Files By Fileid getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalFilesByFileid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the portal file.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
fileId *:
stringThe file ID to identify the target resource.
Response
Successful operation.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Files By Fileid deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalFilesByFileid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Removes the Portal file.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
fileId *:
stringThe file ID to identify the target resource.
Response
Operation completed successfully with no content returned.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Portal Files By Fileid By Filename getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPortalFilesByFileidByFilename
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Same as parent get but allows to set a file name in the content-disposition header for downloading in a browser environment.
Path Parameters
fileId *:
stringThe file ID to identify the target resource.
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
fileName *:
stringThe fileName to identify the target resource.
apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Addrootraml createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidAddrootraml
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Adds the root RAML for this API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Resource created successfully.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Definition getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidDefinition
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the RAML SPEC.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Endpoint getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns the endpoint associated with the API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Endpoint createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an endpoint for the API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
The endpoint has been created.
Update Organizations By Organizationid Apis By Apiid Versions By Apiversionid Endpoint updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the endpoint associated with the API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
The endpoint has been updated.
Patch Organizations By Organizationid Apis By Apiid Versions By Apiversionid Endpoint patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the endpoint associated with the API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Endpoint deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpoint
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the endpoint associated with the API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
The endpoint has been succesfully deleted.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Endpoint Active createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidEndpointActive
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Records activity for an API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
The API version activity has been recorded.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Files getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFiles
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Files createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFiles
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
The new element has been successfully created.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Files Export getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFilesExport
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Exports all files in the filesystem as a ZIP file.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Examples
application/zip
{
"message": "Operation completed successfully."
}
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Files By Apiversionfileid getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFilesByApiversionfileid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Obtain a RAML file (or directory).
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
apiVersionFileId *:
integerThe apiVersionFile ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Update Organizations By Organizationid Apis By Apiid Versions By Apiversionid Files By Apiversionfileid updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFilesByApiversionfileid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces a files.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
apiVersionFileId *:
integerThe apiVersionFile ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Files By Apiversionfileid deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidFilesByApiversionfileid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes a files.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
apiVersionFileId *:
integerThe apiVersionFile ID to identify the target resource.
min: 1, max: 2147483647
Response
Operation completed successfully with no content returned.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Policies getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPolicies
GET
Try it out
Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
standalone *:
booleanThe standalone query parameter.
version *:
stringThe version query parameter.
default:
v1, pattern: ^v\d+(.\d+)?(.\d+)?$fullInfo *:
booleanThe fullInfo query parameter.
default:
TrueHeader Parameters
if-modified-since:
numberLast modification date (EPOC)
Response
Successful operation.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Policies createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPolicies
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
The new element has been successfully created.
Patch Organizations By Organizationid Apis By Apiid Versions By Apiversionid Policies patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPolicies
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates multiple policies. Currently, only updates in order field are supported.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Patch Organizations By Organizationid Apis By Apiid Versions By Apiversionid Policies By Policyid patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPoliciesByPolicyid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a policies.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
policyId *:
integerThe policy ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Policies By Policyid deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPoliciesByPolicyid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Unapplies a policy.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
policyId *:
integerThe policy ID to identify the target resource.
min: 1, max: 2147483647
Response
Operation completed successfully with no content returned.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Policies By Policyid Disable createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPoliciesByPolicyidDisable
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a disable.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
policyId *:
integerThe policy ID to identify the target resource.
min: 1, max: 2147483647
Response
Resource created successfully.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Policies By Policyid Enable createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPoliciesByPolicyidEnable
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a enable.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
policyId *:
integerThe policy ID to identify the target resource.
min: 1, max: 2147483647
Response
Resource created successfully.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Tags By Tag createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTagsByTag
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Adds a tag to an API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
tag *:
stringThe tag to identify the target resource.
maxLength: 150
Response
Resource created successfully.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Tags By Tag deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTagsByTag
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Removes a tag from an API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
tag *:
stringThe tag to identify the target resource.
maxLength: 150
Response
Operation completed successfully with no content returned.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Tiers getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTiers
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of tiers for the supplied api version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
query *:
stringSearch criteria.
offset *:
integerSkip over a number of elements by specifying an offset value for the query.
default:
0, min: 0, max: 2147483647ascending *:
booleanOrder for sorting.
sort *:
stringProperty to sort by.
limit *:
integerLimit the number of elements on the response.
default:
100, min: 1, max: 250active *:
booleanRetrieve only active tiers if set to true.
Response
Successful operation.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Tiers createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTiers
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a sla tier for the API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
The new element has been successfully created.
Update Organizations By Organizationid Apis By Apiid Versions By Apiversionid Tiers By Tierid updateOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTiersByTierid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update a tier associated with an API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
tierId *:
stringThe tier ID to identify the target resource.
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Tiers By Tierid deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidTiersByTierid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Delete a tier that has no active applications.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
tierId *:
stringThe tier ID to identify the target resource.
Response
Operation completed successfully with no content returned.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContracts
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of applications with contracts with the API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
includeExtraRedirections *:
booleanThe includeExtraRedirections query parameter.
query *:
stringSearch criteria.
offset *:
integerSkip over a number of elements by specifying an offset value for the query.
default:
0, min: 0, max: 2147483647coreServicesId *:
stringThe coreServices ID query parameter.
status *:
stringThe status query parameter.
ascending *:
booleanOrder for sorting.
sort *:
stringProperty to sort by.
limit *:
integerLimit the number of elements on the response.
default:
100, min: 1, max: 250includeExtraApplicationData *:
booleanThe includeExtraApplicationData query parameter.
Response
Successful operation.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts By Contractid getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a specific contract for the API version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
contractId *:
stringThe contract ID to identify the target resource.
Response
Successful operation.
Patch Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts By Contractid patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches contract conditions.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
contractId *:
stringThe contract ID to identify the target resource.
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts By Contractid deleteOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the contract.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
contractId *:
stringThe contract ID to identify the target resource.
Response
Operation completed successfully with no content returned.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts By Contractid Approvetierchange createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidApprovetierchange
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a approveTierChange.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
contractId *:
stringThe contract ID to identify the target resource.
Response
Resource created successfully.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts By Contractid Approve createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidApprove
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a approve.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
contractId *:
stringThe contract ID to identify the target resource.
Response
Resource created successfully.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts By Contractid Reject createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidReject
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a reject.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
contractId *:
stringThe contract ID to identify the target resource.
Response
Resource created successfully.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts By Contractid Rejecttierchange createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidRejecttierchange
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a rejectTierChange.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
contractId *:
stringThe contract ID to identify the target resource.
Response
Resource created successfully.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts By Contractid Restore createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidRestore
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a restore.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
contractId *:
stringThe contract ID to identify the target resource.
Response
Resource created successfully.
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Contracts By Contractid Revoke createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidContractsByContractidRevoke
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a revoke.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
contractId *:
stringThe contract ID to identify the target resource.
Response
Resource created successfully.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Proxy getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidProxy
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets a proxy.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Query Parameters
gatewayVersion *:
stringThe gatewayVersion query parameter.
default:
3.8.4Response
Successful operation.
Examples
application/zip
{
"message": "Operation completed successfully."
}
Create Organizations By Organizationid Apis By Apiid Versions By Apiversionid Proxy Deployment createOrganizationsByOrganizationidApisByApiidVersionsByApiversionidProxyDeployment
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a deployment.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Resource created successfully.
Patch Organizations By Organizationid Apis By Apiid Versions By Apiversionid Proxy Deployment patchOrganizationsByOrganizationidApisByApiidVersionsByApiversionidProxyDeployment
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a deployment.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Proxy Deployment Status getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidProxyDeploymentStatus
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the deployment details of a version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Get Organizations By Organizationid Apis By Apiid Versions By Apiversionid Gateway Versions getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidGatewayVersions
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the gateway versions compatible
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Get Organizations By Organizationid Policy Templates getOrganizationsByOrganizationidPolicyTemplates
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieve a list of policy templates.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
version *:
stringThe version query parameter.
pattern:
^v\d+(.\d+)?(.\d+)?$Response
Successful.
Get Organizations By Organizationid Policy Templates By Policytemplateid getOrganizationsByOrganizationidPolicyTemplatesByPolicytemplateid
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.
XML that is being injected as well as all of its configuration parameters.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$policyTemplateId *:
stringThe policyTemplate ID to identify the target resource.
Related Operations:
Query Parameters
version *:
stringThe version query parameter.
pattern:
^v\d+(.\d+)?(.\d+)?$Response
Successful.
Get Organizations By Organizationid Custom Policy Templates getOrganizationsByOrganizationidCustomPolicyTemplates
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of custom policy templates.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
query *:
stringSearch criteria.
offset *:
integerSkip over a number of elements by specifying an offset value for the query.
default:
0, min: 0, max: 2147483647ascending *:
booleanOrder for sorting.
sort *:
stringProperty to sort by.
limit *:
integerLimit the number of elements on the response.
default:
100, min: 1, max: 250Response
Successful operation.
Create Organizations By Organizationid Custom Policy Templates createOrganizationsByOrganizationidCustomPolicyTemplates
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Creates a new custom policy.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
multipart/form-dataResponse
The new element has been successfully created.
Get Organizations By Organizationid Custom Policy Templates By Custompolicytemplateid getOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$customPolicyTemplateId *:
integerThe customPolicyTemplate ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Response
Successful operation.
Update Organizations By Organizationid Custom Policy Templates By Custompolicytemplateid updateOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$customPolicyTemplateId *:
integerThe customPolicyTemplate ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Request Body
jsonResponse
Successful operation.
Patch Organizations By Organizationid Custom Policy Templates By Custompolicytemplateid patchOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$customPolicyTemplateId *:
integerThe customPolicyTemplate ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Custom Policy Templates By Custompolicytemplateid deleteOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$customPolicyTemplateId *:
integerThe customPolicyTemplate ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Response
The element has been deleted successfully.
Get Organizations By Organizationid Custom Policy Templates By Custompolicytemplateid Configuration getOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateidConfiguration
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
The XML configuration for the custom policy template.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$customPolicyTemplateId *:
integerThe customPolicyTemplate ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Response
Successful operation.
Examples
application/xml
{
"message": "Operation completed successfully."
}
Get Organizations By Organizationid Custom Policy Templates By Custompolicytemplateid Definition getOrganizationsByOrganizationidCustomPolicyTemplatesByCustompolicytemplateidDefinition
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
The YAML definition for the custom policy template.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$customPolicyTemplateId *:
integerThe customPolicyTemplate ID to identify the target resource.
min: 1, max: 2147483647
Related Operations:
Response
Successful operation.
Examples
application/yaml
{
"message": "Operation completed successfully."
}
Get Organizations By Organizationid Portals getOrganizationsByOrganizationidPortals
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Create Organizations By Organizationid Portals createOrganizationsByOrganizationidPortals
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
jsonResponse
The new element has been successfully created.
Get Organizations By Organizationid Users getOrganizationsByOrganizationidUsers
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Search for users
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
search *:
stringThe search string to query users for.
includeCurrent *:
booleanWhether to include the currently logged-in user in the search results or not.
offset *:
integerOffset on the amount of assets (each of which has all its apis)
default:
0limit *:
integerLimit on the amount of assets (each of which has all its apis)
default:
25Response
Successful operation.
Examples
application/json
{
"message": "Operation completed successfully."
}
Get Organizations By Organizationid Applications getOrganizationsByOrganizationidApplications
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of applications.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
targetAdminSite *:
booleanRetrieve applications with all the information needed for the admin site.
query *:
stringSearch criteria.
includeContractsForApiVersion *:
integerThis field is used to filter by API version.
offset *:
integerSkip over a number of elements by specifying an offset value for the query.
default:
0, min: 0, max: 2147483647ascending *:
booleanOrder for sorting.
sort:
stringProperty to sort by. Possible values 'id', 'name', 'status', 'createdDate' or 'updatedDate'.
limit *:
integerLimit the number of elements on the response.
default:
100, min: 1, max: 250Response
Successful operation.
Create Organizations By Organizationid Applications createOrganizationsByOrganizationidApplications
POST
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new application.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
apiVersionId:
integerUsed to associate the application with the IDP (Identity Provider) configured on the api instance.
This parameter is not needed when the organization is not fully migrated to crowd or when
the organization does not use a client provider.
This parameter is not needed when the organization is not fully migrated to crowd or when
the organization does not use a client provider.
min: 1
groupInstanceId:
integerUsed to associate the application with the IDP (Identity Provider) configured on the api instances of the group instance.
This parameter is not needed when the organization is not fully migrated to crowd or when
the organization does not use a client provider.
This parameter is not needed when the organization is not fully migrated to crowd or when
the organization does not use a client provider.
min: 1
Request Body
jsonResponse
The new application has been successfully created.
Examples
application/json
{
"redirectUri": [
"http://123.123.123.123:8080/api/v1"
],
"name": "App name",
"description": "App Description",
"url": "http://123.123.123.123:8080/api/v2",
"coreServicesId": "d7eed6c45caa453ca763ba96b22e1bea",
"clientId": "d7eed6c45caa453ca763ba96b22e1bea",
"clientSecret": "53899407a628417d83ee480A099Bfc06",
"audit": {
"created": {
"date": "2017-08-23T14:18:25.504000+00:00"
},
"updated": {}
},
"masterOrganizationId": "40fbc081-bb0d-4aff-9fb7-f3a48fdeb958",
"grantTypes": [
"password",
"implicit",
"client_credentials",
"authorization_code",
"refresh_token"
],
"id": 9
}
Get Organizations By Organizationid Applications By Applicationid getOrganizationsByOrganizationidApplicationsByApplicationid
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
Query Parameters
ignoreOwners *:
booleanRetrieve application with or without owners information.
Response
Successful operation.
Update Organizations By Organizationid Applications By Applicationid updateOrganizationsByOrganizationidApplicationsByApplicationid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
Request Body
jsonResponse
Successful operation.
Patch Organizations By Organizationid Applications By Applicationid patchOrganizationsByOrganizationidApplicationsByApplicationid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Applications By Applicationid deleteOrganizationsByOrganizationidApplicationsByApplicationid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
Response
The element has been deleted successfully.
Create Organizations By Organizationid Applications By Applicationid Secret Reset createOrganizationsByOrganizationidApplicationsByApplicationidSecretReset
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a reset.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
Response
Resource created successfully.
Get Organizations By Organizationid Applications By Applicationid Party Ids getOrganizationsByOrganizationidApplicationsByApplicationidPartyIds
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of Party Ids for a specific api version.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
Query Parameters
apiVersionId *:
integerThe apiVersion ID query parameter.
Response
Successful operation.
Create Organizations By Organizationid Applications By Applicationid Owners createOrganizationsByOrganizationidApplicationsByApplicationidOwners
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Adds an owner to an existing application.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
Request Body
jsonResponse
Resource created successfully.
Delete Organizations By Organizationid Applications By Applicationid Owners By Userid deleteOrganizationsByOrganizationidApplicationsByApplicationidOwnersByUserid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Removes an owner from an existing application.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
userId *:
stringThe user ID to identify the target resource.
Response
Operation completed successfully with no content returned.
Get Organizations By Organizationid Applications By Applicationid Contracts getOrganizationsByOrganizationidApplicationsByApplicationidContracts
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of applications with contracts with the application.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
Query Parameters
query *:
stringSearch criteria.
offset *:
integerSkip over a number of elements by specifying an offset value for the query.
default:
0, min: 0, max: 2147483647ascending *:
booleanOrder for sorting.
sort *:
stringProperty to sort by.
limit *:
integerLimit the number of elements on the response.
default:
100, min: 1, max: 250Response
Successful operation.
Create Organizations By Organizationid Applications By Applicationid Contracts createOrganizationsByOrganizationidApplicationsByApplicationidContracts
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates new contract between an API version and the application.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
Request Body
jsonResponse
The new element has been successfully created.
Patch Organizations By Organizationid Applications By Applicationid Contracts By Contractid patchOrganizationsByOrganizationidApplicationsByApplicationidContractsByContractid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches contract conditions.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$applicationId *:
stringCould be an API Manager application ID or a Core Services client ID.
Related Operations:
contractId *:
stringThe contract ID to identify the target resource.
Request Body
jsonResponse
Successful operation.
Get Organizations By Organizationid Contracts getOrganizationsByOrganizationidContracts
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a contracts.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
apiVersionId *:
integerThe apiVersion ID query parameter.
coreServicesId *:
stringThe coreServices ID query parameter.
Response
Successful operation.
Get Organizations By Organizationid Deployment Targets getOrganizationsByOrganizationidDeploymentTargets
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a deployment targets.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
environmentId *:
stringThe environment ID query parameter.
Related Operations:
Response
Successful operation.
Create Organizations By Organizationid Bundles createOrganizationsByOrganizationidBundles
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/zip
Creates a bundles.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
zipResponse
Resource created successfully.
Get Organizations By Organizationid Public Theme Logo getOrganizationsByOrganizationidPublicThemeLogo
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a logo.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Public Theme Favicon getOrganizationsByOrganizationidPublicThemeFavicon
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a favicon.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Public Permissions getOrganizationsByOrganizationidPublicPermissions
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a permissions.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Public Portals getOrganizationsByOrganizationidPublicPortals
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of elements.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Query Parameters
query[tags] *:
stringA list of keywords for matching API version tags in a search. Used in conjunction with other 'query[xxx]' to perform advanced search. Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded.
requireRaml *:
booleanThe requireRaml query parameter.
query *:
stringSearch criteria.
query[name] *:
stringA list of keywords for matching API name in a search. Used in conjunction with other 'query[xxx]' to perform advanced search. Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded.
query[version] *:
stringA list of keywords for matching API version name in a search. Used in conjunction with other 'query[xxx]' to perform advanced search. Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded.
offset *:
integerSkip over a number of elements by specifying an offset value for the query.
default:
0, min: 0, max: 2147483647deep *:
booleanA boolean value that, when set, would cause the search be perform on the organization associated with 'organizationId' param, as well as all the sub-organizations under it - as long as the login user has permission to view the content.
ascending *:
booleanOrder for sorting.
query[description] *:
stringA list of keywords for matching API version description in a search. Used in conjunction with other 'query[xxx]' to perform advanced search. Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded.
organizationId *:
stringThe organization ID that the search should be run in. If not provided, search would be performed within the organization which the login user is under.
sort *:
stringProperty to sort by.
query[matchAll] *:
booleanA boolean value that determines how other 'query[xxx]' values should work together in an advanced search When 'matchAll' is true, all other 'query[xxx]' would be chained with an 'AND' when performing a search, otherwise they are chained with an 'OR' Note: when any of 'query[xxx]' is used, the query parameter 'query' would be disregarded.
limit *:
integerLimit the number of elements on the response.
default:
100, min: 1, max: 250Response
Successful operation.
Create Organizations By Organizationid Public Portals createOrganizationsByOrganizationidPublicPortals
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Request Body
jsonResponse
The new element has been successfully created.
Get Organizations By Organizationid Public Portals By Portalid Theme Logo getOrganizationsByOrganizationidPublicPortalsByPortalidThemeLogo
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a logo.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$portalId *:
integerThe portal ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Get Organizations By Organizationid Public Portals By Portalid Theme Favicon getOrganizationsByOrganizationidPublicPortalsByPortalidThemeFavicon
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a favicon.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$portalId *:
integerThe portal ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Get Organizations By Organizationid Public Portals Terms getOrganizationsByOrganizationidPublicPortalsTerms
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a terms.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Public Portals Terms Acceptance getOrganizationsByOrganizationidPublicPortalsTermsAcceptance
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a acceptance.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Create Organizations By Organizationid Public Portals Terms By Portaltermsid Acceptance createOrganizationsByOrganizationidPublicPortalsTermsByPortaltermsidAcceptance
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Creates a acceptance.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$portalTermsId *:
integerThe portalTerms ID to identify the target resource.
min: 1, max: 2147483647
Response
Resource created successfully.
Get Organizations By Organizationid Public Apis By Apiid getOrganizationsByOrganizationidPublicApisByApiid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Update Organizations By Organizationid Public Apis By Apiid updateOrganizationsByOrganizationidPublicApisByApiid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Patch Organizations By Organizationid Public Apis By Apiid patchOrganizationsByOrganizationidPublicApisByApiid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Public Apis By Apiid deleteOrganizationsByOrganizationidPublicApisByApiid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
Response
The element has been deleted successfully.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Returns an instance of a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Update Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid updateOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Patch Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid patchOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid deleteOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
The element has been deleted successfully.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Portal getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidPortal
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a portal.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Portal Pages By Pageid Widgets getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidPortalPagesByPageidWidgets
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a widgets.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
pageId *:
stringThe page ID to identify the target resource.
Response
Successful operation.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Portal Files By Fileid getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidPortalFilesByFileid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieve the file by file id. Content-type will be set based on the content-type originally received.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
fileId *:
stringThe file ID to identify the target resource.
Response
Successful.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Portal Files By Fileid By Filename getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidPortalFilesByFileidByFilename
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Same as parent get but allows to set a file name in the content-disposition header for downloading in a browser environment.
Path Parameters
fileId *:
stringThe file ID to identify the target resource.
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
fileName *:
stringThe fileName to identify the target resource.
apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Response
Successful operation.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Tiers getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidTiers
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a tiers.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Definition getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidDefinition
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the RAML SPEC.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Update Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Definition updateOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidDefinition
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Patch Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Definition patchOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidDefinition
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Patches a single element.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Request Body
jsonResponse
Successful operation.
Delete Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Definition deleteOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidDefinition
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the instance of the element specified.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
The element has been deleted successfully.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Files getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidFiles
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Redirect to the root RAML file.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Temporary redirect to the root RAML file.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Files Root getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidFilesRoot
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieve the root RAML file contents.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
Response
Temporary redirect to the root RAML file.
Get Organizations By Organizationid Public Apis By Apiid Versions By Apiversionid Files By Filename getOrganizationsByOrganizationidPublicApisByApiidVersionsByApiversionidFilesByFilename
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieve the RAML contents by file name.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$apiId *:
integerThe api ID to identify the target resource.
min: 1, max: 2147483647
apiVersionId *:
integerThe apiVersion ID to identify the target resource.
min: 1, max: 2147483647
+fileName *:
stringThe +fileName to identify the target resource.
Response
Successful.
Get Policies By Policyid getPoliciesByPolicyid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a policies.
Path Parameters
policyId *:
integerThe policy ID to identify the target resource.
min: 1, max: 2147483647
Response
Successful operation.
Get Ch Domains By Domainname getChDomainsByDomainname
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a ch domains.
Path Parameters
domainName *:
stringThe domainName to identify the target resource.
Response
Successful operation.
Get Gateway Versions getGatewayVersions
GET
Try it out
Custom Query Parameters
Custom Headers
Retrieves a list of gateway versions.
Response
Successful operation.