IBM API Connect Organization Resources API
The Organization Resources API from IBM API Connect — 85 operation(s) for organization resources.
Operations 187
GET
/orgs/{org}/availability-zones/{availability-zone}
Get the Availability Zone object by name or id
#
PATCH
/orgs/{org}/availability-zones/{availability-zone}
Update the Availability Zone object by name or id
#
DELETE
/orgs/{org}/availability-zones/{availability-zone}
Delete the Availability Zone object by name or id
#
POST
/orgs/{org}/availability-zones/{availability-zone}/gateway-services
Create a Gateway Service object
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services
List the Gateway Service objects
#
DELETE
/orgs/{org}/availability-zones/{availability-zone}/gateway-services
Clear the Gateway Service objects
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}
Get the Gateway Service object by name or id
#
PATCH
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}
Update the Gateway Service object by name or id
#
DELETE
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}
Delete the Gateway Service object by name or id
#
POST
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/reset-oauth-secret
Reset the oauth shared crypto material
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/download-logs
Get the Gateway Service download logs
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies
List all Policy objects in all collections
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-name}
List the Policy objects
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-id}
Get the Policy object by id
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-name}/{policy-version}
Get the Policy object by name and version
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-id}/document
Get the Policy document
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/policies/{policy-name}/{policy-version}/document
Get the Policy document by name and version
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions
List all Extension objects in all collections
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-name}
List the Extension objects
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-id}
Get the Extension object by id
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-name}/{extension-version}
Get the Extension object by name and version
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-id}/document
Get the Extension document
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/extensions/{extension-name}/{extension-version}/document
Get the Extension document by name and version
#
POST
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/gateway-extension
Create the Gateway Extension object
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/gateway-extension
Get the Gateway Extension object
#
PUT
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/gateway-extension
Update the Gateway Extension object
#
DELETE
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/gateway-extension
Delete the Gateway Extension object
#
GET
/orgs/{org}/availability-zones/{availability-zone}/gateway-services/{gateway-service}/gateway-extension/implementation
Get the Gateway Extension implementation document
#
POST
/orgs/{org}/availability-zones/{availability-zone}/portal-services
Create a Portal Service object
#
GET
/orgs/{org}/availability-zones/{availability-zone}/portal-services
List the Portal Service objects
#
DELETE
/orgs/{org}/availability-zones/{availability-zone}/portal-services
Clear the Portal Service objects
#
GET
/orgs/{org}/availability-zones/{availability-zone}/portal-services/{portal-service}
Get the Portal Service object by name or id
#
PATCH
/orgs/{org}/availability-zones/{availability-zone}/portal-services/{portal-service}
Update the Portal Service object by name or id
#
DELETE
/orgs/{org}/availability-zones/{availability-zone}/portal-services/{portal-service}
Delete the Portal Service object by name or id
#
POST
/orgs/{org}/availability-zones/{availability-zone}/portal-services/{portal-service}/update-credentials
Update the Portal Service configuration
#
POST
/orgs/{org}/availability-zones/{availability-zone}/analytics-services
Create a Analytics Service object
#
GET
/orgs/{org}/availability-zones/{availability-zone}/analytics-services
List the Analytics Service objects
#
DELETE
/orgs/{org}/availability-zones/{availability-zone}/analytics-services
Clear the Analytics Service objects
#
GET
/orgs/{org}/availability-zones/{availability-zone}/analytics-services/{analytics-service}
Get the Analytics Service object by name or id
#
PATCH
/orgs/{org}/availability-zones/{availability-zone}/analytics-services/{analytics-service}
Update the Analytics Service object by name or id
#
DELETE
/orgs/{org}/availability-zones/{availability-zone}/analytics-services/{analytics-service}
Delete the Analytics Service object by name or id
#
DELETE
/orgs/{org}/tls-server-profiles/{tls-server-profile-name}
Clear the TLS Server Profile objects
#
GET
/orgs/{org}/tls-server-profiles/{tls-server-profile-id}
Get the TLS Server Profile object by id
#
PATCH
/orgs/{org}/tls-server-profiles/{tls-server-profile-id}
Update the TLS Server Profile object by id
#
DELETE
/orgs/{org}/tls-server-profiles/{tls-server-profile-id}
Delete the TLS Server Profile object by id
#
GET
/orgs/{org}/tls-server-profiles/{tls-server-profile-name}/{tls-server-profile-version}
Get the TLS Server Profile object by name and version
#
PATCH
/orgs/{org}/tls-server-profiles/{tls-server-profile-name}/{tls-server-profile-version}
Update the TLS Server Profile object by name and version
#
DELETE
/orgs/{org}/tls-server-profiles/{tls-server-profile-name}/{tls-server-profile-version}
Delete a TLS Server Profile
#
DELETE
/orgs/{org}/tls-client-profiles/{tls-client-profile-name}
Clears TLS client profile versions
#
GET
/orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}
Returns a TLS client profile
#
PATCH
/orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}
Updates a TLS client profile
#
DELETE
/orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}
Delete a TLS Client Profile
#
GET
/orgs/{org}/aliases/xslt-transformations
List all Xslt Transformation Alias objects in all collections
#
DELETE
/orgs/{org}/aliases/xslt-transformations
Clear all Xslt Transformation Alias objects in all collections
#
GET
/orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-name}
List the Xslt Transformation Alias objects
#
DELETE
/orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-name}
Clear the Xslt Transformation Alias objects
#
GET
/orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-id}
Get the Xslt Transformation Alias object by id
#
PATCH
/orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-id}
Update the Xslt Transformation Alias object by id
#
DELETE
/orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-id}
Delete the Xslt Transformation Alias object by id
#
GET
/orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-name}/{xslt-transformation-alias-version}
Get the Xslt Transformation Alias object by name and version
#
PATCH
/orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-name}/{xslt-transformation-alias-version}
Update the Xslt Transformation Alias object by name and version
#
DELETE
/orgs/{org}/aliases/xslt-transformations/{xslt-transformation-alias-name}/{xslt-transformation-alias-version}
Delete a Xslt Transformation Alias
#
GET
/orgs/{org}/aliases/http-transport-securities
List all Http Transport Security Alias objects in all collections
#
DELETE
/orgs/{org}/aliases/http-transport-securities
Clear all Http Transport Security Alias objects in all collections
#
GET
/orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-name}
List the Http Transport Security Alias objects
#
DELETE
/orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-name}
Clear the Http Transport Security Alias objects
#
GET
/orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-id}
Get the Http Transport Security Alias object by id
#
PATCH
/orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-id}
Update the Http Transport Security Alias object by id
#
DELETE
/orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-id}
Delete the Http Transport Security Alias object by id
#
GET
/orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-name}/{http-transport-security-alias-version}
Get the Http Transport Security Alias object by name and version
#
PATCH
/orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-name}/{http-transport-security-alias-version}
Update the Http Transport Security Alias object by name and version
#
DELETE
/orgs/{org}/aliases/http-transport-securities/{http-transport-security-alias-name}/{http-transport-security-alias-version}
Delete a Http Transport Security Alias
#
POST
/orgs/{org}/aliases/webmethods-is-services
Create a Webmethods Integration Server Service Alias object
#
GET
/orgs/{org}/aliases/webmethods-is-services
List all Webmethods Integration Server Service Alias objects in all collections
#
DELETE
/orgs/{org}/aliases/webmethods-is-services
Clear all Webmethods Integration Server Service Alias objects in all collections
#
GET
/orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-name}
List the Webmethods Integration Server Service Alias objects
#
DELETE
/orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-name}
Clear the Webmethods Integration Server Service Alias objects
#
GET
/orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-id}
Get the Webmethods Integration Server Service Alias object by id
#
PATCH
/orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-id}
Update the Webmethods Integration Server Service Alias object by id
#
DELETE
/orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-id}
Delete the Webmethods Integration Server Service Alias object by id
#
GET
/orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-name}/{webmethods-is-service-alias-version}
Get the Webmethods Integration Server Service Alias object by name and version
#
PATCH
/orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-name}/{webmethods-is-service-alias-version}
Update the Webmethods Integration Server Service Alias object by name and…
#
DELETE
/orgs/{org}/aliases/webmethods-is-services/{webmethods-is-service-alias-name}/{webmethods-is-service-alias-version}
Delete a Webmethods Integration Server Service Alias
#
PATCH
/orgs/{org}/watsonx-settings/{watsonx-settings}
Update the Watsonx Settings object by name or id
#
DELETE
/orgs/{org}/watsonx-settings/{watsonx-settings}
Delete the Watsonx Settings object by name or id
#
GET
/orgs/{org}/analytics-services/{analytics-service}
Get the Analytics Service object by name or id
#
GET
/orgs/{org}/programming-packages/{programming-package-name}
List the Programming Package objects
#
DELETE
/orgs/{org}/programming-packages/{programming-package-name}
Clear the Programming Package objects
#
GET
/orgs/{org}/programming-packages/{programming-package-id}
Get the Programming Package object by id
#
PATCH
/orgs/{org}/programming-packages/{programming-package-id}
Update the Programming Package object by id
#
DELETE
/orgs/{org}/programming-packages/{programming-package-id}
Delete the Programming Package object by id
#
GET
/orgs/{org}/programming-packages/{programming-package-name}/{programming-package-version}
Get the Programming Package object by name and version
#
PATCH
/orgs/{org}/programming-packages/{programming-package-name}/{programming-package-version}
Update the Programming Package object by name and version
#
DELETE
/orgs/{org}/programming-packages/{programming-package-name}/{programming-package-version}
Delete a Programming Package
#
Documentation
📖
Documentation
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
GettingStarted
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
Authentication
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cli-managing-platform-rest-api-keys