REST API for Oracle API Catalog Cloud Service

API Collections REST Endpoints

API Collections

The API Collections API lets you retrieve the API Collections metadata and API descriptions in OpenAPI (formerly Swagger) format.

Create an API: Method: post

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis
Create an API Collection: Method: post

Path: /v1/orgs/{org}/apicollections
Create or Update an API Collection: Method: put

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Delete an API: Method: delete

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}
Delete an API Collection: Method: delete

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Query API Collections by Filter: Method: get

Path: /v1/apicollections/
Retrieve All API Collections in an Organization: Method: get

Path: /v1/orgs/{org}/apicollections
Retrieve an API Collection: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Retrieve API Metadata: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}
Retrieve OpenAPI (formerly Swagger) Description: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}/canonical
Retrieve User API Collections: Method: get

Path: /v1/user/apicollections/
Retrieve User-Uploaded API Description: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}/raw
Update an API Collection: Method: patch

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Update Existing API: Method: put

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}
Update User-Uploaded API Description: Method: put

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}/raw

API Collections

The API Collections API lets you retrieve the API Collections metadata and API descriptions in OpenAPI (formerly Swagger) format.

Query API Collections by Filter: Method: get

Path: /v1/apicollections/
Retrieve All API Collections in an Organization: Method: get

Path: /v1/orgs/{org}/apicollections
Create an API Collection: Method: post

Path: /v1/orgs/{org}/apicollections
Delete an API Collection: Method: delete

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Retrieve an API Collection: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Update an API Collection: Method: patch

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Create or Update an API Collection: Method: put

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Create an API: Method: post

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis
Delete an API: Method: delete

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}
Retrieve API Metadata: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}
Update Existing API: Method: put

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}
Retrieve OpenAPI (formerly Swagger) Description: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}/canonical
Retrieve User-Uploaded API Description: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}/raw
Update User-Uploaded API Description: Method: put

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}/raw
Retrieve User API Collections: Method: get

Path: /v1/user/apicollections/

API Collections

The API Collections API lets you retrieve the API Collections metadata and API descriptions in OpenAPI (formerly Swagger) format.

Delete an API Collection: Method: delete

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Delete an API: Method: delete

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}
Query API Collections by Filter: Method: get

Path: /v1/apicollections/
Retrieve All API Collections in an Organization: Method: get

Path: /v1/orgs/{org}/apicollections
Retrieve an API Collection: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Retrieve API Metadata: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}
Retrieve OpenAPI (formerly Swagger) Description: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}/canonical
Retrieve User-Uploaded API Description: Method: get

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}/raw
Retrieve User API Collections: Method: get

Path: /v1/user/apicollections/
Update an API Collection: Method: patch

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Create an API Collection: Method: post

Path: /v1/orgs/{org}/apicollections
Create an API: Method: post

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis
Create or Update an API Collection: Method: put

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}
Update Existing API: Method: put

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}
Update User-Uploaded API Description: Method: put

Path: /v1/orgs/{org}/apicollections/{apiCollectionName}/{apiCollectionVersion}/apis/{apiName}/raw